unitelabs.labware.math.placement

Attributes

  • Name
    Number
    Type
    Value

    = typing.Union[str, int, float, tuple[int, collections.abc.Sequence[int], int], decimal.Decimal]

    Description

Functions

  • place(
      cols : int,
      rows : int,
      offset : typing.Optional[Vector],
      direction,
      justify,
      align,
    ) -> typing.Generator[tuple[Vector, Vector], None, None]

    Calculates the location of rows x cols items around the center of the parent's plane.

    Parameters

    • Name
      cols
      Type
      int
      Default
      Description

      The number of items along the x axis.

    • Name
      rows
      Type
      int
      Default
      Description

      The number of items along the y axis.

    • Name
      item
      Type
      Vector
      Default
      Description

      Each item's dimension.

    • Name
      boundary
      Type
      Vector
      Default
      Description

      The container's dimension.

    • Name
      offset
      Type
      typing.Optional[Vector]
      Default
      = None
      Description

      Optional offset to apply to the item's location.

    • Name
      direction
      Type
      Default
      = COLUMN_ROW
      Description

      Establishes the direction in which items are placed in the container.

    • Name
      justify
      Type
      Default
      = CENTER
      Description

      Defines the alignment along the x-axis.

    • Name
      align
      Type
      Default
      = CENTER
      Description

      Defines the alignment along the y-axis.

    • Name
      stack
      Type
      typing.Literal[START, CENTER, END]
      Default
      = END
      Description

      Defines the alignment along the z-axis.

    Response

    Type
    typing.Generator[tuple[Vector, Vector], None, None]
    Description

    Tuples for each items' location and dimension.

  • place_standardized(
      count : typing.Literal[96, 384, 1536],
      boundary_height : typing.Optional[Number],
      item_height : typing.Optional[Number]
    ) -> typing.Generator[tuple[Vector, Vector], None, None]

    Place wells on a plate according to the ANSI / SLAS microplate standard.

    Parameters

    • Name
      count
      Type
      typing.Literal[96, 384, 1536]
      Default
      Description

      The number of items to place on the resource.

    • Name
      boundary_height
      Type
      typing.Optional[Number]
      Default
      = None
      Description

    • Name
      item_height
      Type
      typing.Optional[Number]
      Default
      = None
      Description

    Response

    Type
    typing.Generator[tuple[Vector, Vector], None, None]
    Description

    Tuples for each items' location and dimension.

Classes

  • Direction

    Defines the direction in which items are placed in the container.

    Bases
    enum.Enum

    Attributes

    • Name
      COLUMN_ROW
      Type
      Value

      = enum.auto()

      Description

      Starting at the top left corner, moving from top to bottom, then from left to right.

    • Name
      COLUMN_REVERSE_ROW
      Type
      Value

      = enum.auto()

      Description

      Starting at the bottom left corner, moving from bottom to top, then from left to right.

    • Name
      COLUMN_ROW_REVERSE
      Type
      Value

      = enum.auto()

      Description

      Starting at the top right corner, moving from top to bottom, then from right to left.

    • Name
      COLUMN_REVERSE_ROW_REVERSE
      Type
      Value

      = enum.auto()

      Description

      Starting at the bottom right corner, moving from bottom to top, then from right to left.

    • Name
      ROW_COLUMN
      Type
      Value

      = enum.auto()

      Description

      Starting at the top left corner, moving from left to right, then from top to bottom.

    • Name
      ROW_COLUMN_REVERSE
      Type
      Value

      = enum.auto()

      Description

      Starting at the bottom left corner, moving from left to right, then from bottom to top.

    • Name
      ROW_REVERSE_COLUMN
      Type
      Value

      = enum.auto()

      Description

      Starting at the top right corner, moving from right to left, then from top to bottom.

    • Name
      ROW_REVERSE_COLUMN_REVERSE
      Type
      Value

      = enum.auto()

      Description

      Starting at the bottom right corner, moving from right to left, then from bottom to top.

  • Alignment

    Defines the alignment and distribution of items along an axis.

    Bases
    enum.Enum

    Attributes

    • Name
      START
      Type
      Value

      = enum.auto()

      Description

      Items are packed toward the start of the direction.

    • Name
      END
      Type
      Value

      = enum.auto()

      Description

      Items are packed toward the end of the direction.

    • Name
      CENTER
      Type
      Value

      = enum.auto()

      Description

      Items are centered along the direction.

    • Name
      SPACE_BETWEEN
      Type
      Value

      = enum.auto()

      Description

      Items are evenly distributed in the direction; first item is on the start line, last item on the end line.

    • Name
      SPACE_AROUND
      Type
      Value

      = enum.auto()

      Description

      Items are evenly distributed in the direction with equal space around them.

    • Name
      SPACE_EVENLY
      Type
      Value

      = enum.auto()

      Description

      Items are distributed so that the spacing between any two items (and the space to the edges) is equal.

Copyright © 2024