Source code for asap.stack.schemas

from argschema.fields import (Str, Int, Slice, Float, Boolean,
                              List, Nested, InputDir)
from argschema.schemas import DefaultSchema

from asap.module.schemas import (RenderParameters,
                                          StackTransitionParameters)


class ConsolidateTransformsParameters(RenderParameters):
    stack = Str(required=True,
                description='stack to consolidate')
    postfix = Str(required=False, default="_CONS",
                  description=(
                      'postfix to add to stack name on saving if no '
                      'output defined (default _CONS)'))
    transforms_slice = Slice(
        required=True,
        description=("a string representing a slice describing "
                     "the set of transforms to be consolidated (i.e. 1:)"))
    output_stack = Str(
        required=False,
        description=('name of output stack (default to adding '
                     'postfix to input)'))
    pool_size = Int(
        required=False, default=10,
        description=(
            'name of output stack (default to adding postfix to input)'))
    minZ = Float(
        required=False,
        description=(
            "minimum z to consolidate in read in from stack and write "
            "to output_stack. Default to minimum z in stack"))
    maxZ = Float(
        required=False,
        description=(
            "maximum z to consolidate in read in from stack and write "
            "to output_stack.  Default to maximum z in stack"))
    overwrite_zlayer = Boolean(
        required=False, default=False,
        description=("whether to remove the existing layer from the "
                     "target stack before uploading."))
    close_stack = Boolean(required=False, default=False)


class ConsolidateTransformsOutputParameters(DefaultSchema):
    output_stack = Str(required=True, description="name of output stack")
    numZ = Int(required=True, description="Number of z values processed")


class MipMapDirectories(DefaultSchema):
    level = Int(required=True, description=(
        "mipMapLevel for which parent directory will be changed"))
    directory = InputDir(required=True, description=(
        "directory where relocated mipmaps are found."))


class RedirectMipMapsParameters(StackTransitionParameters):
    new_mipmap_directories = Nested(
        MipMapDirectories, required=True, many=True)


class RedirectMipMapsOutput(DefaultSchema):
    zValues = List(Int, required=True)
    output_stack = Str(required=True)


class RemapZsParameters(StackTransitionParameters):
    remap_sectionId = Boolean(required=False)
    new_zValues = List(Int, required=True)


class RemapZsOutput(DefaultSchema):
    zValues = List(Int, required=True)
    output_stack = Str(required=True)


class SwapZsParameters(RenderParameters):
    source_stack = List(
        Str,
        required=True,
        description="List of source stacks")
    target_stack = List(
        Str,
        required=True,
        description="List of target stacks")
    complete_source_stack = Boolean(
        required=False,
        default=False,
        missing=False,
        description=(
            "set source stack state to complete after copying Default=False"))
    complete_target_stack = Boolean(
        required=False,
        default=False,
        missing=False,
        description=(
            "set target stack state to complete after copying Default=False"))
    zValues = List(List(
        Int,
        required=True))
    delete_source_stack = Boolean(
        required=False,
        default=False,
        missing=False,
        description=(
            "Do you want to delete source stack after copying "
            "its contents?. Default=False"))
    pool_size = Int(
        required=False,
        default=5,
        missing=5,
        description="Pool size")


class SwapZsOutput(DefaultSchema):
    source_stacks = List(
        Str,
        required=True,
        description=(
            "List of source stacks that have been successfully swapped"))
    target_stacks = List(
        Str,
        required=True,
        description=(
            "List of target stacks that have been successfully swapped"))
    swapped_zvalues = List(List(
        Int,
        required=True))