Skip to main content

MixedKeyword

Enum MixedKeyword 

Source
pub enum MixedKeyword {
    PnCalibration(f32, String),
    PnD(String, f32, f32),
    PnE(f32, f32),
    GnE(f32, f32),
    RnW(Vec<f32>),
    SPILLOVER {
        n_parameters: usize,
        parameter_names: Vec<String>,
        matrix_values: Vec<f32>,
    },
    PnL(Vec<usize>),
}

Variants§

§

PnCalibration(f32, String)

Specifies the conversion of arbitrary signal units, recorded as parameter values (uncompensated or compensated) to some well defined unit. For example, mean equivalent soluble fluorochrome (MESF) or antibody molecules.

  • f1 - the number of calibrated units corresponding to a unit signal value of parameter n

  • str - name of the units corresponding to calibration value

Example: If the signal on parameter n has the scale value X then the calibrated value is X * f units

§

PnD(String, f32, f32)

Recommends visualization scale for parameter n.

  • String is either “Linear” or “Logarithmic”.
  • f1 and f2 parameter values are in “scale” units, not “channel” units, see below for details.
  • For linear scaling:
    • f1: Lower bound - the scale value corresponding to the left edge of the display
    • f2: Upper bound - the scale value corresponding to the right edge of the display
  • For logarithmic scaling:
    • f1: Decades - The number of decades to display.
    • f2: Offset - The scale value corresponding to the left edge of the display

Example: $P3D (Linear,0,1024)

  • Specifies a linear display range with scale parameter values ranging from 0 to 1024.

Example: $P2D (Logarithmic,4,0.1)

  • Specifies a logarithmic display ranging from 0.1 to 1000 (scale value), which is 4 decades of display width.

Example: $P1D (Logarithmic,5,0.01)

  • Specifies a logarithmic display ranging from 0.01 to 1000 (scale value), which is 5 decades of display width.

Example: $P3B (8) | $P3R (256) | $P3G (4) | $P3E (0,0) | $P3D (Linear,0,32):

  • This is a linear parameter with channel values going from 0 to 255 ($P3R). Taking account the gain ($PnG), the scale values go from 0 to 64 (256/4 = 64). The $P3D specifies a linear display from 0 to 32 scale units, which only encompasses the bottom half of the collected data range on this scale.

Example: $P4B (16) | $P4R (1024) | $P4E (4,1) | $P4D (Linear,0,1000)

  • Specifies a linear display, with channel values going from 0 to 1023 ($P4R). Only the bottom 10th of the scale values shown. This will restrict the display to channel values between 0 and 768 (the bottom 3 decades), with channels being distributed exponentially in the linear display.

Example: $P4B (16) | $P4R (1024) | $P4E (4,1) | $P4D (Logarithmic,3,1):

  • The display keyword specifies that the data should be shown in logarithmic scaling, with only the bottom 3 decades shown. This will restrict the display to channel values between 0 and 768 (1024*3/4).
§

PnE(f32, f32)

(f1, f2) -Amplification type for parameter n. (FCS 1.0+)

  • f1 - number of logarithmic decades
  • f2 - linear value obtained for a signal with log value = 0
  • 0,0 when the parameter is Linear.
  • Also 0,0 when floating-point data ($DATATYPE = F or $DATATYPE = D) is stored. Example: $P3E (4,1) - 4 decades with offset of 1
§

GnE(f32, f32)

Gate n amplification type.

(FCS v2.0-3.1, deprecated)

§

RnW(Vec<f32>)

Region n width values - vector of width values for region boundaries Example: $R1W (0.5,1.2,0.8) - Three width values

§

SPILLOVER

Spillover matrix for compensation Format: n, [param_names…], [matrix_values…] Example: $SPILLOVER/3,FL2-A,FL1-A,FL3-A,1.0,0.03,0.2,0.1,1.0,0.0,0.05,0,1.0

Fields

§n_parameters: usize
§parameter_names: Vec<String>
§matrix_values: Vec<f32>
§

PnL(Vec<usize>)

Excitation wavelength(s) for parameter n in nanometers (FCS 1.0+, format updated in FCS 3.1) Can contain single or multiple wavelengths for co-axial lasers Example: $P3L (488) - single wavelength Example: $P4L (488,532,633) - multiple co-axial lasers

Trait Implementations§

Source§

impl Clone for MixedKeyword

Source§

fn clone(&self) -> MixedKeyword

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MixedKeyword

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for MixedKeyword

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for MixedKeyword

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Hash for MixedKeyword

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for MixedKeyword

Source§

fn eq(&self, other: &MixedKeyword) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for MixedKeyword

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StringableKeyword for MixedKeyword

Source§

fn get_str(&self) -> Cow<'_, str>

Source§

impl Eq for MixedKeyword

Source§

impl StructuralPartialEq for MixedKeyword

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> ByRef<T> for T

Source§

fn by_ref(&self) -> &T

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DistributionExt for T
where T: ?Sized,

Source§

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Key for T
where T: Clone,

Source§

fn align() -> usize

The alignment necessary for the key. Must return a power of two.
Source§

fn size(&self) -> usize

The size of the key in bytes.
Source§

unsafe fn init(&self, ptr: *mut u8)

Initialize the key in the given memory location. Read more
Source§

unsafe fn get<'a>(ptr: *const u8) -> &'a T

Get a reference to the key from the given memory location. Read more
Source§

unsafe fn drop_in_place(ptr: *mut u8)

Drop the key in place. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToCompactString for T
where T: Display,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T> ToStringFallible for T
where T: Display,

Source§

fn try_to_string(&self) -> Result<String, TryReserveError>

ToString::to_string, but without panic on OOM.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

Source§

impl<T> PlanCallbackArgs for T

Source§

impl<T> PlanCallbackOut for T