Struct Parameter 

pub struct Parameter {
    pub parameter_number: usize,
    pub channel_name: ChannelName,
    pub label_name: LabelName,
    pub transform: TransformType,
    pub state: ParameterProcessing,
    pub excitation_wavelength: Option<usize>,
}

Fields

parameter_number: usize

The offset of the parameter in the FCS file’s event data (1-based index)

channel_name: ChannelName

The name of the channel ($PnN keyword)

label_name: LabelName

The label name of the parameter ($PnS keyword)

transform: TransformType

The default transform to apply to the parameter

state: ParameterProcessing

Instructions for parameter processing (compensation, unmixing, etc.) This enum indicates what transformations should be applied.

excitation_wavelength: Option<usize>

Excitation wavelength in nanometers (from $PnL keyword, if available)

Implementations

impl Parameter

pub fn new( parameter_number: &usize, channel_name: &str, label_name: &str, transform: &TransformType, ) -> Self

Creates a new Parameter with the specified properties

Arguments

• parameter_number - The 1-based index of the parameter in the FCS file
• channel_name - The channel name from the $PnN keyword (e.g., “FSC-A”, “FL1-A”)
• label_name - The label name from the $PnS keyword (e.g., “CD8”, “CD4”)
• transform - The default transformation type to apply

Returns

A new Parameter with Raw processing state and no excitation wavelength

pub fn is_fluorescence(&self) -> bool

Check if this parameter is fluorescence (should be transformed by default) Excludes FSC (forward scatter), SSC (side scatter), and Time

pub fn get_display_label(&self) -> String

Get the display label for this parameter Format examples:

• Raw: “UV379-A::CD8” or just “FSC-A”
• Compensated: “Comp::UV379-A::CD8”
• Unmixed: “Unmix::UV379-A::CD8”
• UnmixedCompensated: “Comp+Unmix::UV379-A::CD8”

pub fn get_short_label(&self) -> String

Get the short label (without state prefix)

pub fn with_state(&self, state: ParameterProcessing) -> Self

Create a new parameter with updated state

pub fn with_transform(&self, transform: TransformType) -> Self

Create a new parameter with updated transform

pub fn generate_plot_options( &self, include_compensated: bool, ) -> Vec<ParameterOption>

Generate parameter options for plotting interfaces

Creates a list of ParameterOption structs representing different processing states of this parameter that can be used for plotting.

For fluorescence parameters:

• Always returns transformed versions (arcsinh applied)
• If include_compensated is true, also includes compensated+transformed versions
• Includes unmixed versions if compensation is available

For non-fluorescence parameters (FSC, SSC, Time):

• Returns raw (untransformed) versions only

Arguments

• include_compensated - Whether to include compensated and unmixed variants

Returns

A vector of ParameterOption structs ready for use in plotting UIs

Trait Implementations

impl Clone for Parameter

fn clone(&self) -> Parameter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Parameter

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

Formats the value using the given formatter.

impl Hash for Parameter

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Serialize for Parameter

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

where __S: Serializer,

Serialize this value into the given Serde serializer.