SurfaceSpecification

pydantic model SurfaceSpecification[source]

Specifies relevant values describing a regular surface object.

Fields:
field rotation: float [Required]

Rotation angle in degrees.

Constraints:
  • allow_inf_nan = False

field undef: float [Required]

Value representing undefined data.

Constraints:
  • allow_inf_nan = False

field xinc: float [Required]

Increment along the x-axis.

Constraints:
  • ge = 0

  • allow_inf_nan = False

field yinc: float [Required]

Increment along the y-axis.

Constraints:
  • ge = 0

  • allow_inf_nan = False

field xori: float [Required]

Origin along the x-axis.

Constraints:
  • allow_inf_nan = False

field yflip: enums.AxisOrientation [Required]

Flip along the y-axis, -1 or 1.

field yori: float [Required]

Origin along the y-axis.

Constraints:
  • allow_inf_nan = False

field nrow: int [Required]

The number of rows.

Constraints:
  • ge = 0

field ncol: int [Required]

The number of columns.

Constraints:
  • ge = 0