asap.stack package

Submodules

asap.stack.consolidate_transforms module

class asap.stack.consolidate_transforms.ConsolidateTransforms(schema_type=None, *args, **kwargs)

Bases: RenderModule

Note

This class takes a ArgSchema as an input to parse inputs , with a default schema of type ConsolidateTransformsParameters

default_output_schema

alias of ConsolidateTransformsOutputParameters

default_schema

alias of ConsolidateTransformsParameters

run()

asap.stack.consolidate_transforms.consolidate_transforms(tforms, ref_tforms=[], logger=<RootLogger root (WARNING)>, makePolyDegree=0, keep_ref_tforms=False)

asap.stack.consolidate_transforms.dereference_tforms(tforms, ref_tforms)

asap.stack.consolidate_transforms.flatten_and_dereference_tforms(tforms, ref_tforms)

asap.stack.consolidate_transforms.flatten_tforms(tforms)

asap.stack.consolidate_transforms.process_z(render, stack, outstack, transform_slice, z)

asap.stack.redirect_mipmaps module

change storage directory of imageUrl in a given mipMapLevel

class asap.stack.redirect_mipmaps.RedirectMipMapsModule(schema_type=None, *args, **kwargs)

Bases: StackTransitionModule

Note

This class takes a ArgSchema as an input to parse inputs , with a default schema of type RedirectMipMapsParameters

default_output_schema

alias of RedirectMipMapsOutput

default_schema

alias of RedirectMipMapsParameters

static get_replacement_ImagePyramid(ip, mml_d_map)

run()

asap.stack.schemas module

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

Bases: DefaultSchema

ConsolidateTransformsOutputParameters

key	description	default	field_type	json_type
output_stack	name of output stack	(REQUIRED)	String	str
numZ	Number of z values processed	(REQUIRED)	Integer	int

opts = <marshmallow.schema.SchemaOpts object>

class asap.stack.schemas.ConsolidateTransformsParameters(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

ConsolidateTransformsParameters

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
stack	stack to consolidate	(REQUIRED)	String	str
postfix	postfix to add to stack name on saving if no output defined (default _CONS)	_CONS	String	str
transforms_slice	a string representing a slice describing the set of transforms to be consolidated (i.e. 1:)	slice(None, None, None)	Slice	str
output_stack	name of output stack (default to adding postfix to input)	NA	String	str
pool_size	name of output stack (default to adding postfix to input)	10	Integer	int
minZ	minimum z to consolidate in read in from stack and write to output_stack. Default to minimum z in stack	NA	Float	float
maxZ	maximum z to consolidate in read in from stack and write to output_stack. Default to maximum z in stack	NA	Float	float
overwrite_zlayer	whether to remove the existing layer from the target stack before uploading.	False	Boolean	bool
close_stack	no description	False	Boolean	bool

opts = <marshmallow.schema.SchemaOpts object>

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

Bases: DefaultSchema

MipMapDirectories

key	description	default	field_type	json_type
level	mipMapLevel for which parent directory will be changed	(REQUIRED)	Integer	int
directory	directory where relocated mipmaps are found.	(REQUIRED)	InputDir	str

opts = <marshmallow.schema.SchemaOpts object>

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

Bases: DefaultSchema

RedirectMipMapsOutput

key	description	default	field_type	json_type
zValues	no description	(REQUIRED)	List	int
output_stack	no description	(REQUIRED)	String	str

opts = <marshmallow.schema.SchemaOpts object>

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

Bases: StackTransitionParameters

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

RedirectMipMapsParameters

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
new_mipmap_directories	no description	(REQUIRED)	MipMapDirectories	list

opts = <marshmallow.schema.SchemaOpts object>

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

Bases: DefaultSchema

RemapZsOutput

key	description	default	field_type	json_type
zValues	no description	(REQUIRED)	List	int
output_stack	no description	(REQUIRED)	String	str

opts = <marshmallow.schema.SchemaOpts object>

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

Bases: StackTransitionParameters

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

RemapZsParameters

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
remap_sectionId	no description	NA	Boolean	bool
new_zValues	no description	(REQUIRED)	List	int

opts = <marshmallow.schema.SchemaOpts object>

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

Bases: DefaultSchema

SwapZsOutput

key	description	default	field_type	json_type
source_stacks	List of source stacks that have been successfully swapped	(REQUIRED)	List	str
target_stacks	List of target stacks that have been successfully swapped	(REQUIRED)	List	str
swapped_zvalues	no description	NA	List	?

opts = <marshmallow.schema.SchemaOpts object>

class asap.stack.schemas.SwapZsParameters(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

SwapZsParameters

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
source_stack	List of source stacks	(REQUIRED)	List	str
target_stack	List of target stacks	(REQUIRED)	List	str
complete_source_stack	set source stack state to complete after copying Default=False	False	Boolean	bool
complete_target_stack	set target stack state to complete after copying Default=False	False	Boolean	bool
zValues	no description	NA	List	?
delete_source_stack	Do you want to delete source stack after copying its contents?. Default=False	False	Boolean	bool
pool_size	Pool size	5	Integer	int

opts = <marshmallow.schema.SchemaOpts object>

Module contents