Struct BitmaskLayerParams 

pub struct BitmaskLayerParams {
    pub layer_id: String,
    pub bounds: Option<MarginParams>,
    pub data_unit_mode_x: UnitsMode,
    pub data_unit_mode_y: UnitsMode,
    pub stroke_width_unit_mode: UnitsMode,
    pub pixel_offset: Option<(u32, u32)>,
    pub model_matrix: Option<[f32; 16]>,
    pub dimension_order: DimensionOrder,
    pub shape: Vec<u32>,
    pub channel_settings: Vec<BitmaskChannelSettings>,
    pub opacity: f32,
    pub data: NumericData,
}

Layer params struct for BitmaskLayer.

Fields

layer_id: String

bounds: Option<MarginParams>

data_unit_mode_x: UnitsMode

data_unit_mode_y: UnitsMode

stroke_width_unit_mode: UnitsMode

How to interpret every channel’s BitmaskChannelSettings::stroke_width. Analogous to the same field on the stroked polygon/curve layers.

Unlike those layers there is no stroke geometry to widen – which fragments are stroked is decided from the bitmask data on the fly in the shader.

The boundary test samples such that a Pixels width renders the same number of screen pixels thick whether the mask is coarse or fine.

pixel_offset: Option<(u32, u32)>

model_matrix: Option<[f32; 16]>

dimension_order: DimensionOrder

The order of dimensions in the flat data array.

shape: Vec<u32>

The size of each dimension, in the same order as dimension_order. For example, if dimension_order is “CYX” and the mask is 256x256 with 3 segmentation channels, then shape would be [3, 256, 256].

channel_settings: Vec<BitmaskChannelSettings>

One entry per channel (i.e. one per the “C” dimension of shape), specifying how to color that channel’s segmentation mask. Each channel may represent a different type of objects, for instance, the first channel may contain cell segmentations while the second channel may contain nuclei segmentations.

opacity: f32

Overall opacity multiplier applied to the layer as a whole, on top of each channel’s own opacity.

data: NumericData

Flat array of per-pixel, per-channel object ids, in the order specified by dimension_order. A value of 0 means “no object” (background) at that pixel; object ids are otherwise expected to be 1-based (object k is id k + 1), matching the ColorMode index each channel resolves colors against. Supports multiple numeric dtypes (u8, u16, u32, u64, i8, i16, i32, i64, f32, f64).

Trait Implementations

impl Clone for BitmaskLayerParams

fn clone(&self) -> BitmaskLayerParams

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BitmaskLayerParams

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for BitmaskLayerParams

fn default() -> BitmaskLayerParams

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BitmaskLayerParams

where BitmaskLayerParams: Default,

fn deserialize<__D>( __deserializer: __D, ) -> Result<BitmaskLayerParams, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for BitmaskLayerParams

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.