asap.module.schemas package

Submodules

asap.module.schemas.renderclient_schemas module

class asap.module.schemas.renderclient_schemas.FeatureExtractionParameters(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: DefaultSchema

FeatureExtractionParameters

key	description	default	field_type	json_type
SIFTfdSize	SIFT feature descriptor size – samples per row and column. 8 if excluded or None	NA	Integer	int
SIFTminScale	SIFT minimum scale – minSize * minScale < size < maxSize * maxScale. 0.5 if excluded or None	NA	Float	float
SIFTmaxScale	SIFT maximum scale – minSize * minScale < size < maxSize * maxScale. 0.85 if excluded or None	NA	Float	float
SIFTsteps	SIFT steps per scale octave. 3 if excluded or None	NA	Integer	int

opts = <marshmallow.schema.SchemaOpts object>

class asap.module.schemas.renderclient_schemas.FeatureRenderClipParameters(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: DefaultSchema

FeatureRenderClipParameters

key	description	default	field_type	json_type
clipWidth	Full scale pixels to include in clipped rendering of LEFT/RIGHT oriented tile pairs. Will not LEFT/RIGHT clip if excluded or None.	NA	Integer	int
clipHeight	Full scale pixels to include in clipped rendering of TOP/BOTTOM oriented tile pairs. Will not TOP/BOTTOM clip if excluded or None.	NA	Integer	int

opts = <marshmallow.schema.SchemaOpts object>

class asap.module.schemas.renderclient_schemas.FeatureRenderParameters(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: DefaultSchema

FeatureRenderParameters

key	description	default	field_type	json_type
renderScale	Scale at which image tiles will be rendered. 1.0 (full scale) if excluded or None	NA	Float	float
renderWithFilter	Render tiles using default filtering (0 and 255 pixel values replaced with integer in U(64, 191), followed by default NormalizeLocalContrast). True if excluded or None	NA	Boolean	bool
renderWithoutMask	Render tiles without mipMapLevel masks. True if excluded or None	NA	Boolean	bool
renderFullScaleWidth	Full scale width for all rendered tiles	NA	Integer	int
renderFullScaleHeight	Full scale height for all rendered tiles	NA	Integer	int
fillWithNoise	Fill each canvas image with noise prior to rendering. True if excluded or None	NA	Boolean	bool
renderFilterListName	Apply specified filter list to all renderings	NA	String	str

opts = <marshmallow.schema.SchemaOpts object>

class asap.module.schemas.renderclient_schemas.FeatureStorageParameters(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: DefaultSchema

FeatureStorageParameters

key	description	default	field_type	json_type
rootFeatureDirectory	Root directory for saved feature lists. Features extracted from dynamically rendered canvases if excluded or None.	NA	String	str
requireStoredFeatures	Whether to throw an exception in case features stored in rootFeatureDirectory cannot be found. Missing features are extracted from dynamically rendered canvases if excluded or None	NA	Boolean	bool
maxFeatureCacheGb	Maximum size of feature cache, in GB. 2GB if excluded or None	NA	Integer	int

opts = <marshmallow.schema.SchemaOpts object>

class asap.module.schemas.renderclient_schemas.MatchDerivationParameters(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: DefaultSchema

MatchDerivationParameters

key	description	default	field_type	json_type
matchRod	Ratio of first to second nearest neighbors used as a cutoff in matching features. 0.92 if excluded or None	NA	Float	float
matchModelType	Model to match for RANSAC filtering. ‘AFFINE’ if excluded or None	NA	String	str
matchIterations	RANSAC filter iterations. 1000 if excluded or None	NA	Integer	int
matchMaxEpsilon	no description	NA	Float	float
matchMinInlierRatio	Minimal ratio of inliers to candidates for successful RANSAC filtering. 0.0 if excluded or None	NA	Float	float
matchMinNumInliers	Minimum absolute number of inliers for successful RANSAC filtering. 4 if excluded or None	NA	Integer	int
matchMaxNumInliers	Maximum absolute number of inliers allowed after RANSAC filtering. unlimited if excluded or None	NA	Integer	int
matchMaxTrust	Maximum trust for filtering such that candidates with cost larger than matchMaxTrust * median cost are rejected. 3.0 if excluded or None	NA	Float	float
matchFilter	whether to match one set of matches, or multiple sets. And, whether to keep them separate, or aggregate them. SINGLE_SET if excluded or None.	NA	String	str

opts = <marshmallow.schema.SchemaOpts object>

class asap.module.schemas.renderclient_schemas.MatchWebServiceParameters(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: WebServiceParameters

MatchWebServiceParameters

key	description	default	field_type	json_type
baseDataUrl	api endpoint url e.g. http://<host>[:port]/render-ws/v1	NA	String	str
owner	owner of match collection	NA	String	str
collection	match collection name	NA	String	str

opts = <marshmallow.schema.SchemaOpts object>

class asap.module.schemas.renderclient_schemas.MaterializedBoxParameters(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: DefaultSchema

MaterializedBoxParameters

key	description	default	field_type	json_type
stack	stack fromw which boxes will be materialized	(REQUIRED)	String	str
rootDirectory	directory in which materialization directory structure will be created (structure is <rootDirectory>/<project>/<stack>/<width>x<height>/<mipMapLevel>/<z>/<row>/<col>.<fmt>)	(REQUIRED)	OutputDir	str
width	width of flat rectangular tiles to generate	(REQUIRED)	Integer	int
height	height of flat rectangular tiles to generate	(REQUIRED)	Integer	int
maxLevel	maximum mipMapLevel to generate.	0	Integer	int
fmt	image format to generate mipmaps – PNG if not specified	NA	String	str
maxOverviewWidthAndHeight	maximum pixel size for width or height of overview image. If excluded or 0, no overview generated.	NA	Integer	int
skipInterpolation	whether to skip interpolation (e.g. DMG data)	NA	Boolean	bool
binaryMask	whether to use binary mask (e.g. DMG data)	NA	Boolean	bool
label	whether to generate single color tile labels rather than actual images	NA	Boolean	bool
createIGrid	whther to create an IGrid file	NA	Boolean	bool
forceGeneration	whether to regenerate existing tiles	NA	Boolean	bool
renderGroup	index (1-n) identifying coarse portion of layer to render	NA	Integer	int
numberOfRenderGroups	used in conjunction with renderGroup, total number of groups being used	NA	Integer	int
filterListName	Apply specified filter list to all renderings	NA	String	str

opts = <marshmallow.schema.SchemaOpts object>

class asap.module.schemas.renderclient_schemas.RenderParametersMatchWebServiceParameters(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: MatchWebServiceParameters

RenderParametersMatchWebServiceParameters

key	description	default	field_type	json_type
baseDataUrl	api endpoint url e.g. http://<host>[:port]/render-ws/v1	NA	String	str
owner	owner of match collection	NA	String	str
collection	match collection name	NA	String	str
render	no description	NA	RenderClientParameters	dict

opts = <marshmallow.schema.SchemaOpts object>

validate_options(data)

class asap.module.schemas.renderclient_schemas.RenderParametersRenderWebServiceParameters(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: RenderWebServiceParameters

RenderParametersRenderWebServiceParameters

key	description	default	field_type	json_type
baseDataUrl	api endpoint url e.g. http://<host>[:port]/render-ws/v1	NA	String	str
owner	owner of target collection	NA	String	str
project	project fo target collection	NA	String	str
render	no description	NA	RenderClientParameters	dict

opts = <marshmallow.schema.SchemaOpts object>

validate_options(data)

class asap.module.schemas.renderclient_schemas.RenderWebServiceParameters(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: WebServiceParameters

RenderWebServiceParameters

key	description	default	field_type	json_type
baseDataUrl	api endpoint url e.g. http://<host>[:port]/render-ws/v1	NA	String	str
owner	owner of target collection	NA	String	str
project	project fo target collection	NA	String	str

opts = <marshmallow.schema.SchemaOpts object>

class asap.module.schemas.renderclient_schemas.WebServiceParameters(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: DefaultSchema

WebServiceParameters

key	description	default	field_type	json_type
baseDataUrl	api endpoint url e.g. http://<host>[:port]/render-ws/v1	NA	String	str

opts = <marshmallow.schema.SchemaOpts object>

class asap.module.schemas.renderclient_schemas.ZRangeParameters(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: DefaultSchema

ZRangeParameters

key	description	default	field_type	json_type
minZ	minimum Z integer	NA	Integer	int
maxZ	maximum Z integer	NA	Integer	int

opts = <marshmallow.schema.SchemaOpts object>

asap.module.schemas.schemas module

class asap.module.schemas.schemas.RenderClientParameters(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: DefaultSchema

RenderClientParameters

key	description	default	field_type	json_type
host	render host	(REQUIRED)	String	str
port	render post integer	(REQUIRED)	Integer	int
owner	render default owner	(REQUIRED)	String	str
project	render default project	(REQUIRED)	String	str
client_scripts	path to render client scripts	(REQUIRED)	String	str
memGB	string describing java heap memory (default 5G)	5G	String	str

opts = <marshmallow.schema.SchemaOpts object>

class asap.module.schemas.schemas.RenderParameters(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: ArgSchema

This schema is designed to be a schema_type for an ArgSchemaParser object

RenderParameters

key	description	default	field_type	json_type
input_json	file path of input json file	NA	InputFile	str
output_json	file path to output json file	NA	OutputFile	str
log_level	set the logging level of the module	ERROR	LogLevel	str
render	parameters to connect to render server	(REQUIRED)	RenderClientParameters	dict

opts = <marshmallow.schema.SchemaOpts object>

class asap.module.schemas.schemas.TemplateOutputParameters(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: DefaultSchema

TemplateOutputParameters

key	description	default	field_type	json_type
output_value	an output of the module	(REQUIRED)	String	str

opts = <marshmallow.schema.SchemaOpts object>

class asap.module.schemas.schemas.TemplateParameters(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: RenderParameters

This schema is designed to be a schema_type for an ArgSchemaParser object

TemplateParameters

key	description	default	field_type	json_type
input_json	file path of input json file	NA	InputFile	str
output_json	file path to output json file	NA	OutputFile	str
log_level	set the logging level of the module	ERROR	LogLevel	str
render	parameters to connect to render server	(REQUIRED)	RenderClientParameters	dict
example	an example	(REQUIRED)	String	str
default_val	an example with a default	a default value	String	str

opts = <marshmallow.schema.SchemaOpts object>

asap.module.schemas.spark_schemas module

class asap.module.schemas.spark_schemas.SparkOptions(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: DefaultSchema

SparkOptions

key	description	default	field_type	json_type
jarfile	spark jar to call java spark command	(REQUIRED)	String	str
className	spark class to call	(REQUIRED)	String	str
driverMemory	spark driver memory (important for local spark)	6g	String	str
memory	Memory required for spark job	NA	String	str
sparkhome	Spark home directory containing bin/spark_submit	(REQUIRED)	InputDir	str
spark_files	list of spark files to add to the spark submit command	NA	List	str
spark_conf	dictionary of key value pairs to add to spark_submit as –conf key=value	NA	Dict	?

opts = <marshmallow.schema.SchemaOpts object>

class asap.module.schemas.spark_schemas.SparkParameters(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: SparkOptions

SparkParameters

key	description	default	field_type	json_type
jarfile	spark jar to call java spark command	(REQUIRED)	String	str
className	spark class to call	(REQUIRED)	String	str
driverMemory	spark driver memory (important for local spark)	6g	String	str
memory	Memory required for spark job	NA	String	str
sparkhome	Spark home directory containing bin/spark_submit	(REQUIRED)	InputDir	str
spark_files	list of spark files to add to the spark submit command	NA	List	str
spark_conf	dictionary of key value pairs to add to spark_submit as –conf key=value	NA	Dict	?
masterUrl	spark master url. For local execution local[num_procs,num_retries]	(REQUIRED)	String	str

opts = <marshmallow.schema.SchemaOpts object>

asap.module.schemas.stack_schemas module

class asap.module.schemas.stack_schemas.InputStackParameters(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: RenderParameters, ZValueParameters, OverridableParameterSchema

template schema for schemas which take input from a stack

This schema is designed to be a schema_type for an ArgSchemaParser object

InputStackParameters

key	description	default	field_type	json_type
minZ	no description	NA	Integer	int
maxZ	no description	NA	Integer	int
z	no description	NA	Integer	int
zValues	no description	NA	List	int
input_json	file path of input json file	NA	InputFile	str
output_json	file path to output json file	NA	OutputFile	str
log_level	set the logging level of the module	ERROR	LogLevel	str
render	parameters to connect to render server	(REQUIRED)	RenderClientParameters	dict
input_stack	no description	(REQUIRED)	String	str

opts = <marshmallow.schema.SchemaOpts object>

class asap.module.schemas.stack_schemas.OutputStackParameters(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: RenderParameters, ZValueParameters, ProcessPoolParameters, OverridableParameterSchema

template schema for writing tilespecs to an output stack

This schema is designed to be a schema_type for an ArgSchemaParser object

OutputStackParameters

key	description	default	field_type	json_type
pool_size	no description	1	Integer	int
minZ	no description	NA	Integer	int
maxZ	no description	NA	Integer	int
z	no description	NA	Integer	int
zValues	no description	NA	List	int
input_json	file path of input json file	NA	InputFile	str
output_json	file path to output json file	NA	OutputFile	str
log_level	set the logging level of the module	ERROR	LogLevel	str
render	parameters to connect to render server	(REQUIRED)	RenderClientParameters	dict
output_stack	no description	(REQUIRED)	String	str
close_stack	no description	False	Boolean	bool
overwrite_zlayer	no description	False	Boolean	bool
output_stackVersion	no description	NA	RenderStackVersion	dict

opts = <marshmallow.schema.SchemaOpts object>

class asap.module.schemas.stack_schemas.OverridableParameterSchema(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: DefaultSchema

static fix_badkey(data, badkey, goodkey)

opts = <marshmallow.schema.SchemaOpts object>

override_input(data)

class asap.module.schemas.stack_schemas.ProcessPoolParameters(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: DefaultSchema

ProcessPoolParameters

key	description	default	field_type	json_type
pool_size	no description	1	Integer	int

opts = <marshmallow.schema.SchemaOpts object>

class asap.module.schemas.stack_schemas.RenderCycle(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: DefaultSchema

RenderCycle

key	description	default	field_type	json_type
number	no description	NA	Integer	int
stepNumber	no description	NA	Integer	int

opts = <marshmallow.schema.SchemaOpts object>

class asap.module.schemas.stack_schemas.RenderMipMapPathBuilder(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: DefaultSchema

RenderMipMapPathBuilder

key	description	default	field_type	json_type
rootPath	no description	NA	String	str
numberOfLevels	no description	NA	Integer	int
extension	no description	NA	String	str

opts = <marshmallow.schema.SchemaOpts object>

class asap.module.schemas.stack_schemas.RenderStackVersion(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: DefaultSchema

RenderStackVersion

key	description	default	field_type	json_type
createTimestamp	no description	NA	String	str
versionNotes	no description	NA	String	str
cycleNumber	no description	NA	Integer	int
cycleStepNumber	no description	NA	Integer	int
stackResolutionX	no description	NA	Float	float
stackResolutionY	no description	NA	Float	float
stackResolutionZ	no description	NA	Float	float
materializedBoxRootPath	no description	NA	String	str
mipmapPathBuilder	no description	NA	RenderMipMapPathBuilder	dict
cycle	no description	NA	RenderCycle	dict
stackResolutionValues	no description	NA	List	int

opts = <marshmallow.schema.SchemaOpts object>

class asap.module.schemas.stack_schemas.StackTransitionParameters(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: OutputStackParameters, InputStackParameters

template schema for schemas which take input from one stack, perform (mostly render-python based) operations on tiles from that stack, and output tiles to another stack.

This schema is designed to be a schema_type for an ArgSchemaParser object

StackTransitionParameters

key	description	default	field_type	json_type
pool_size	no description	1	Integer	int
minZ	no description	NA	Integer	int
maxZ	no description	NA	Integer	int
z	no description	NA	Integer	int
zValues	no description	NA	List	int
input_json	file path of input json file	NA	InputFile	str
output_json	file path to output json file	NA	OutputFile	str
log_level	set the logging level of the module	ERROR	LogLevel	str
render	parameters to connect to render server	(REQUIRED)	RenderClientParameters	dict
input_stack	no description	(REQUIRED)	String	str
output_stack	no description	(REQUIRED)	String	str
close_stack	no description	False	Boolean	bool
overwrite_zlayer	no description	False	Boolean	bool
output_stackVersion	no description	NA	RenderStackVersion	dict

opts = <marshmallow.schema.SchemaOpts object>

class asap.module.schemas.stack_schemas.ZValueParameters(extra=None, only=None, exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: OverridableParameterSchema

template schema which interprets z values on which to act assumes a hierarchy such that minZ, maxZ are superceded by z which is superceded by zValues.

ZValueParameters

key	description	default	field_type	json_type
minZ	no description	NA	Integer	int
maxZ	no description	NA	Integer	int
z	no description	NA	Integer	int
zValues	no description	NA	List	int

generate_zValues(data)

opts = <marshmallow.schema.SchemaOpts object>

Module contents