ome_types.model.simple_types¶

Module is only here for backwards compatibility with v<0.4.0 of ome-types.

Most of the types defined here are also exported from ome_types.model. But for now, you can also import them from here.

`Binning` ¶

Bases: Enum

Represents the number of pixels that are combined to form larger pixels.

{used:CCD,EMCCD}

Attributes:

Name	Type	Description
`ONEBYONE`	`str`	No binning.
`TWOBYTWO`	`str`	2×2 binning.
`FOURBYFOUR`	`str`	4×4 binning.
`EIGHTBYEIGHT`	`str`	8×8 binning.
`OTHER`	`str`	Other binning value.

`Color` ¶

Bases: Color

A Pydantic Color subclass that converts to and from OME int32 types.

`as_int32() -> int` ¶

Convert to an int32, with alpha in the least significant byte.

`Marker` ¶

Bases: Enum

Shape of marker on the end of a line.

[enumeration]

`NamingConvention` ¶

Bases: Enum

Predefined list of values for the well labels.

Attributes:

Name	Type	Description
`LETTER`	`str`	While the label type 'number' has a clear meaning the 'letter' type is more complex. If you have less than 26 values use letters A to Z. Once you get more than 26 values there are several different approaches in use. One we have see include: Single letter, then double letter each running A to Z, right first e.g. A, B, C, ... X, Y, Z, AA, AB, AC, ... AY, AZ, BA, BB, ... This is the format used by Microsoft Excel so users may be familiar with it. This is the approach we use in the OMERO client applications. CAPITALsmall, each running A to Z, small first e.g. Aa, Ab, Ac, ... Ax, Ay, Az, Ba, Bb, Bc, ... By, Bz, Ca, Cb, ... This is in use by some plate manufactures. Single letter, then double letter, then triple letter, and so on e.g. A, B, C, ... X, Y, Z, AA, BB, CC, ... YY, ZZ, AAA, BBB, ... This has the advantage that the first 26 are the same as the standard but has a problem an the labels get wider and wider leading to user interface problems.
`NUMBER`	`str`	1, 2, 3, ...

`PixelType` ¶

Bases: Enum

The number size/kind used to represent a pixel.

Attributes:

Name	Type	Description
`INT8`	`str`	8 bit signed integer.
`INT16`	`str`	16 bit signed integer.
`INT32`	`str`	32 bit signed integer.
`UINT8`	`str`	8 bit unsigned integer.
`UINT16`	`str`	16 bit unsigned integer.
`UINT32`	`str`	32 bit unsigned integer.
`FLOAT`	`str`	single-precision floating point.
`DOUBLE`	`str`	double-precision floating point.
`COMPLEXFLOAT`	`str`	complex single-precision floating point.
`COMPLEXDOUBLE`	`str`	complex double-precision floating point.
`BIT`	`str`	bit mask.

`UnitsAngle` ¶

Bases: Enum

The units used to represent an angle.

`UnitsElectricPotential` ¶

Bases: Enum

The units used to represent an electric potential.

Attributes:

Name	Type	Description
`YOTTAVOLT`	`str`	yottavolt unit.
`ZETTAVOLT`	`str`	zettavolt unit.
`EXAVOLT`	`str`	exavolt unit.
`PETAVOLT`	`str`	petavolt unit.
`TERAVOLT`	`str`	teravolt unit.
`GIGAVOLT`	`str`	gigavolt unit.
`MEGAVOLT`	`str`	megavolt unit.
`KILOVOLT`	`str`	kilovolt unit.
`HECTOVOLT`	`str`	hectovolt unit.
`DECAVOLT`	`str`	decavolt unit.
`VOLT`	`str`	volt unit.
`DECIVOLT`	`str`	decivolt unit.
`CENTIVOLT`	`str`	centivolt unit.
`MILLIVOLT`	`str`	millivolt unit.
`MICROVOLT`	`str`	microvolt unit.
`NANOVOLT`	`str`	nanovolt unit.
`PICOVOLT`	`str`	picovolt unit.
`FEMTOVOLT`	`str`	femtovolt unit.
`ATTOVOLT`	`str`	attovolt unit.
`ZEPTOVOLT`	`str`	zeptovolt unit.
`YOCTOVOLT`	`str`	yoctovolt unit.

`UnitsFrequency` ¶

Bases: Enum

The units used to represent frequency.

Attributes:

Name	Type	Description
`YOTTAHERTZ`	`str`	yottahertz unit.
`ZETTAHERTZ`	`str`	zettahertz unit.
`EXAHERTZ`	`str`	exahertz unit.
`PETAHERTZ`	`str`	petahertz unit.
`TERAHERTZ`	`str`	terahertz unit.
`GIGAHERTZ`	`str`	gigahertz unit.
`MEGAHERTZ`	`str`	megahertz unit.
`KILOHERTZ`	`str`	kilohertz unit.
`HECTOHERTZ`	`str`	hectohertz unit.
`DECAHERTZ`	`str`	decahertz unit.
`HERTZ`	`str`	hertz unit.
`DECIHERTZ`	`str`	decihertz unit.
`CENTIHERTZ`	`str`	centihertz unit.
`MILLIHERTZ`	`str`	millihertz unit.
`MICROHERTZ`	`str`	microhertz unit.
`NANOHERTZ`	`str`	nanohertz unit.
`PICOHERTZ`	`str`	picohertz unit.
`FEMTOHERTZ`	`str`	femtohertz unit.
`ATTOHERTZ`	`str`	attohertz unit.
`ZEPTOHERTZ`	`str`	zeptohertz unit.
`YOCTOHERTZ`	`str`	yoctohertz unit.

`UnitsLength` ¶

Bases: Enum

The units used to represent a length.

Attributes:

Name	Type	Description
`YOTTAMETER`	`str`	yottameter SI unit.
`ZETTAMETER`	`str`	zettameter SI unit.
`EXAMETER`	`str`	exameter SI unit.
`PETAMETER`	`str`	petameter SI unit.
`TERAMETER`	`str`	terameter SI unit.
`GIGAMETER`	`str`	gigameter SI unit.
`MEGAMETER`	`str`	megameter SI unit.
`KILOMETER`	`str`	kilometer SI unit.
`HECTOMETER`	`str`	hectometer SI unit.
`DECAMETER`	`str`	decameter SI unit.
`METER`	`str`	meter SI unit.
`DECIMETER`	`str`	decimeter SI unit.
`CENTIMETER`	`str`	centimeter SI unit.
`MILLIMETER`	`str`	millimeter SI unit.
`MICROMETER`	`str`	micrometer SI unit.
`NANOMETER`	`str`	nanometer SI unit.
`PICOMETER`	`str`	picometer SI unit.
`FEMTOMETER`	`str`	femtometer SI unit.
`ATTOMETER`	`str`	attometer SI unit.
`ZEPTOMETER`	`str`	zeptometer SI unit.
`YOCTOMETER`	`str`	yoctometer SI unit.
`ANGSTROM`	`str`	ångström SI-derived unit.
`THOU`	`str`	thou Imperial unit (or mil, 1/1000 inch).
`LINE`	`str`	line Imperial unit (1/12 inch).
`INCH`	`str`	inch Imperial unit.
`FOOT`	`str`	foot Imperial unit.
`YARD`	`str`	yard Imperial unit.
`MILE`	`str`	terrestrial mile Imperial unit.
`ASTRONOMICALUNIT`	`str`	astronomical unit SI-derived unit. The official term is ua as the SI standard assigned AU to absorbance unit.
`LIGHTYEAR`	`str`	light year.
`PARSEC`	`str`	parsec.
`POINT`	`str`	typography point Imperial-derived unit (1/72 inch). Use of this unit should be limited to font sizes.
`PIXEL`	`str`	pixel abstract unit. This is not convertible to any other length unit without a calibrated scaling factor. Its use should should be limited to ROI objects, and converted to an appropriate length units using the PhysicalSize units of the Image the ROI is attached to.
`REFERENCEFRAME`	`str`	reference frame abstract unit. This is not convertible to any other length unit without a scaling factor. Its use should be limited to uncalibrated stage positions, and converted to an appropriate length unit using a calibrated scaling factor.

`UnitsPower` ¶

Bases: Enum

The units used to represent power.

Attributes:

Name	Type	Description
`YOTTAWATT`	`str`	yottawatt unit.
`ZETTAWATT`	`str`	zettawatt unit.
`EXAWATT`	`str`	exawatt unit.
`PETAWATT`	`str`	petawatt unit.
`TERAWATT`	`str`	terawatt unit.
`GIGAWATT`	`str`	gigawatt unit.
`MEGAWATT`	`str`	megawatt unit.
`KILOWATT`	`str`	kilowatt unit.
`HECTOWATT`	`str`	hectowatt unit.
`DECAWATT`	`str`	decawatt unit.
`WATT`	`str`	watt unit.
`DECIWATT`	`str`	deciwatt unit.
`CENTIWATT`	`str`	centiwatt unit.
`MILLIWATT`	`str`	milliwatt unit.
`MICROWATT`	`str`	microwatt unit.
`NANOWATT`	`str`	nanowatt unit.
`PICOWATT`	`str`	picowatt unit.
`FEMTOWATT`	`str`	femtowatt unit.
`ATTOWATT`	`str`	attowatt unit.
`ZEPTOWATT`	`str`	zeptowatt unit.
`YOCTOWATT`	`str`	yoctowatt unit.

`UnitsPressure` ¶

Bases: Enum

The units used to represent a pressure.

Attributes:

Name	Type	Description
`YOTTAPASCAL`	`str`	yottapascal SI unit.
`ZETTAPASCAL`	`str`	zettapascal SI unit.
`EXAPASCAL`	`str`	exapascal SI unit.
`PETAPASCAL`	`str`	petapascal SI unit.
`TERAPASCAL`	`str`	terapascal SI unit.
`GIGAPASCAL`	`str`	gigapascal SI unit.
`MEGAPASCAL`	`str`	megapascal SI unit.
`KILOPASCAL`	`str`	kilopascal SI unit.
`HECTOPASCAL`	`str`	hectopascal SI unit.
`DECAPASCAL`	`str`	decapascal SI unit.
`PASCAL`	`str`	pascal SI unit. Note the C++ enum is mixed case due to PASCAL being a macro used by the Microsoft C and C++ compiler.
`DECIPASCAL`	`str`	decipascal SI unit.
`CENTIPASCAL`	`str`	centipascal SI unit.
`MILLIPASCAL`	`str`	millipascal SI unit.
`MICROPASCAL`	`str`	micropascal SI unit.
`NANOPASCAL`	`str`	nanopascal SI unit.
`PICOPASCAL`	`str`	picopascal SI unit.
`FEMTOPASCAL`	`str`	femtopascal SI unit.
`ATTOPASCAL`	`str`	attopascal SI unit.
`ZEPTOPASCAL`	`str`	zeptopascal SI unit.
`YOCTOPASCAL`	`str`	yoctopascal SI unit.
`BAR`	`str`	bar SI-derived unit.
`MEGABAR`	`str`	megabar SI-derived unit.
`KILOBAR`	`str`	kilobar SI-derived unit.
`DECIBAR`	`str`	decibar SI-derived unit.
`CENTIBAR`	`str`	centibar SI-derived unit.
`MILLIBAR`	`str`	millibar SI-derived unit.
`ATMOSPHERE`	`str`	standard atmosphere SI-derived unit.
`PSI`	`str`	pound-force per square inch Imperial unit.
`TORR`	`str`	torr SI-derived unit.
`MILLITORR`	`str`	millitorr SI-derived unit.
`MMHG`	`str`	millimetre of mercury SI-derived unit

`UnitsTemperature` ¶

Bases: Enum

The units used to represent a temperature.

Attributes:

Name	Type	Description
`CELSIUS`	`str`	degree Celsius unit.
`FAHRENHEIT`	`str`	degree Fahrenheit unit.
`KELVIN`	`str`	Kelvin unit.
`RANKINE`	`str`	degree Rankine unit.

`UnitsTime` ¶

Bases: Enum

The units used to represent a time interval.

Attributes:

Name	Type	Description
`YOTTASECOND`	`str`	yottasecond SI unit.
`ZETTASECOND`	`str`	zettasecond SI unit.
`EXASECOND`	`str`	exasecond SI unit.
`PETASECOND`	`str`	petasecond SI unit.
`TERASECOND`	`str`	terasecond SI unit.
`GIGASECOND`	`str`	gigasecond SI unit.
`MEGASECOND`	`str`	megasecond SI unit.
`KILOSECOND`	`str`	kilosecond SI unit.
`HECTOSECOND`	`str`	hectosecond SI unit.
`DECASECOND`	`str`	decasecond SI unit.
`SECOND`	`str`	second SI unit.
`DECISECOND`	`str`	decisecond SI unit.
`CENTISECOND`	`str`	centisecond SI unit.
`MILLISECOND`	`str`	millisecond SI unit.
`MICROSECOND`	`str`	microsecond SI unit.
`NANOSECOND`	`str`	nanosecond SI unit.
`PICOSECOND`	`str`	picosecond SI unit.
`FEMTOSECOND`	`str`	femtosecond SI unit.
`ATTOSECOND`	`str`	attosecond SI unit.
`ZEPTOSECOND`	`str`	zeptosecond SI unit.
`YOCTOSECOND`	`str`	yoctosecond SI unit.
`MINUTE`	`str`	minute SI-derived unit.
`HOUR`	`str`	hour SI-derived unit.
`DAY`	`str`	day SI-derived unit.

ome_types.model.simple_types¶

Binning ¶

Color ¶

as_int32() -> int ¶

Marker ¶

NamingConvention ¶

PixelType ¶

UnitsAngle ¶

UnitsElectricPotential ¶

UnitsFrequency ¶

UnitsLength ¶

UnitsPower ¶

UnitsPressure ¶

UnitsTemperature ¶

UnitsTime ¶

`Binning` ¶

`Color` ¶

`as_int32() -> int` ¶

`Marker` ¶

`NamingConvention` ¶

`PixelType` ¶

`UnitsAngle` ¶

`UnitsElectricPotential` ¶

`UnitsFrequency` ¶

`UnitsLength` ¶

`UnitsPower` ¶

`UnitsPressure` ¶

`UnitsTemperature` ¶

`UnitsTime` ¶