Package me.clarius.sdk

Enum Class Param

java.lang.Object
java.lang.Enum<Param>
me.clarius.sdk.Param
All Implemented Interfaces:
Serializable, Comparable<Param>, Constable
public enum Param extends Enum<Param>
Imaging parameters.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    AutoFocus
    Auto focus enable (default on all applications).
    AutoGain
    Auto gain enable (default on for most applications).
    Chroma
    Chroma map enable (default off).
    ColorGain
    Color/power gain in percent (default 50%).
    ColorInvert
    Color map invert (default off - red towards probe, blue away from probe).
    ColorPrf
    Color/power pulse repetition frequency in kHz (default dependent on application).
    ColorSteer
    Color/power steering angle in degrees (available on linear probes, default dependent on application).
    DopplerVelocity
    Read only velocity range in [cm/s] if the system is operating in a Doppler mode based on the current PRF programmed (returns 0 if not in a doppler mode).
    DynamicRange
    Dynamic range in percent (default 50%).
    EcoMode
    Eco mode enable (default off).
    FocusDepth
    Focus depth in cm (applied when auto focus turned off).
    Gain
    Gain in percent (default 50%).
    ImageDepth
    Imaging depth in cm (default dependent on application).
    ImuStreaming
    IMU streaming enable (default off).
    NeedleSide
    Needle enhance side (default 0 - LED side).
    PwGain
    Pulsed wave Doppler gain in [percent] (default 50%).
    PwPrf
    Pulsed wave Doppler pulse repetition frequency in [kHz] (default dependent on application).
    PwSteer
    Pulsed wave Doppler steering angle in [degrees] (available on linear probes, default dependent on application).
    RawBuffer
    Raw data buffering enable (default off).
    RfStreaming
    RF streaming enable (default on).
    Smooth
    Smooth enable (default on for most applications).
    StrainOpacity
    Opacity of the strain image overlay (default 50%).
    SyncPulse
    Sync pulse enable (default off).
    Trapezoidal
    Trapezoidal imaging enable (available on linear probes, default off for most applications).

  • Method Summary

    Modifier and Type
    Method
    Description
    static Param
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static Param[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • ImageDepth

      public static final Param ImageDepth
      Imaging depth in cm (default dependent on application).

    • Gain

      public static final Param Gain
      Gain in percent (default 50%).

    • AutoGain

      public static final Param AutoGain
      Auto gain enable (default on for most applications).

    • DynamicRange

      public static final Param DynamicRange
      Dynamic range in percent (default 50%).

    • Chroma

      public static final Param Chroma
      Chroma map enable (default off).

    • Smooth

      public static final Param Smooth
      Smooth enable (default on for most applications).

    • AutoFocus

      public static final Param AutoFocus
      Auto focus enable (default on all applications).

    • FocusDepth

      public static final Param FocusDepth
      Focus depth in cm (applied when auto focus turned off).

    • Trapezoidal

      public static final Param Trapezoidal
      Trapezoidal imaging enable (available on linear probes, default off for most applications).

    • ColorGain

      public static final Param ColorGain
      Color/power gain in percent (default 50%).

    • ColorPrf

      public static final Param ColorPrf
      Color/power pulse repetition frequency in kHz (default dependent on application).

    • ColorSteer

      public static final Param ColorSteer
      Color/power steering angle in degrees (available on linear probes, default dependent on application).

    • ColorInvert

      public static final Param ColorInvert
      Color map invert (default off - red towards probe, blue away from probe).

    • PwGain

      public static final Param PwGain
      Pulsed wave Doppler gain in [percent] (default 50%).

    • PwPrf

      public static final Param PwPrf
      Pulsed wave Doppler pulse repetition frequency in [kHz] (default dependent on application).

    • PwSteer

      public static final Param PwSteer
      Pulsed wave Doppler steering angle in [degrees] (available on linear probes, default dependent on application).

    • DopplerVelocity

      public static final Param DopplerVelocity
      Read only velocity range in [cm/s] if the system is operating in a Doppler mode based on the current PRF programmed (returns 0 if not in a doppler mode).

    • NeedleSide

      public static final Param NeedleSide
      Needle enhance side (default 0 - LED side).

    • StrainOpacity

      public static final Param StrainOpacity
      Opacity of the strain image overlay (default 50%).

    • RawBuffer

      public static final Param RawBuffer
      Raw data buffering enable (default off).

    • RfStreaming

      public static final Param RfStreaming
      RF streaming enable (default on).

    • ImuStreaming

      public static final Param ImuStreaming
      IMU streaming enable (default off).

    • SyncPulse

      public static final Param SyncPulse
      Sync pulse enable (default off).

    • EcoMode

      public static final Param EcoMode
      Eco mode enable (default off).

  • Method Details

    • values

      public static Param[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static Param valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null