Index (Solum API Reference for Android)

A B C D E F G H I J K L M N O P Q R S T U V W X Y
All Classes and Interfaces|All Packages|Constant Field Values

A

accept(boolean) - Method in interface me.clarius.sdk.Solum.BooleanResult: Called with the request result.
accept(boolean) - Method in interface me.clarius.sdk.Solum.InitializationResult: Called with the request result.
accept(boolean, String, double, String, String, String) - Method in interface me.clarius.sdk.Solum.TeeCallback: Called when the tee callback was invoked.
accept(int) - Method in interface me.clarius.sdk.Solum.RequestRawDataCallback: Called with the request result.
accept(int, int) - Method in interface me.clarius.sdk.Solum.Progress: Called with the request result.
accept(int, long[], long[]) - Method in interface me.clarius.sdk.Solum.RequestRawDataAvailabilityCallback: Called with the request result.
accept(int, ByteBuffer) - Method in interface me.clarius.sdk.Solum.ReadRawDataCallback: Called with the request result.
accept(String[]) - Method in interface me.clarius.sdk.Solum.StringListResult: Called with the request result.
accept(Optional<Double>) - Method in interface me.clarius.sdk.Solum.LowLevelParamResult: Called with the request result.
accept(Optional<Double>) - Method in interface me.clarius.sdk.Solum.ParamResult: Called with the request result.
accept(Optional<String>) - Method in interface me.clarius.sdk.Solum.FirmwareVersionResult: Called with the request result.
accept(Optional<GateLines>) - Method in interface me.clarius.sdk.Solum.GateLinesResult: Called with the request result.
accept(Optional<Mode>) - Method in interface me.clarius.sdk.Solum.ModeResult: Called with the request result.
accept(Optional<ProbeInfo>) - Method in interface me.clarius.sdk.Solum.ProbeInfoResult: Called with the request result.
accept(Optional<Range>) - Method in interface me.clarius.sdk.Solum.RangeResult: Called with the request result.
accept(Optional<StatusInfo>) - Method in interface me.clarius.sdk.Solum.StatusResult: Called with the request result.
accept(Optional<Tgc>) - Method in interface me.clarius.sdk.Solum.TgcResult: Called with the request result.
accept(PointF[]) - Method in interface me.clarius.sdk.Solum.RoiResult: Called with the request result.
accept(SwUpdate) - Method in interface me.clarius.sdk.Solum.SoftwareUpdateResult: Called with the request result.
Acoustic - Class in me.clarius.sdk: Acoustic index values to send to the API.
Acoustic() - Constructor for class me.clarius.sdk.Acoustic: Default constructor.
Acoustic(double, double, double, double) - Constructor for class me.clarius.sdk.Acoustic: Constructor with parameters.
active - Variable in class me.clarius.sdk.GateLines: Active region for signal.
adjustGate(int, int) - Method in class me.clarius.sdk.Solum: Adjust the gate.
adjustRoi(RoiFunction, double, double) - Method in class me.clarius.sdk.Solum: Move the ROI.
alarmOnUndock - Variable in class me.clarius.sdk.ProbeSettings: Sound an alarm when probe comes out of charging dock.
angle - Variable in class me.clarius.sdk.ProcessedImageInfo: acquisition angle for volumetric data.
angle - Variable in class me.clarius.sdk.RawImageInfo: acquisition angle for volumetric data.
autoBoot - Variable in class me.clarius.sdk.ProbeSettings: Auto boot probe when it comes out of deep sleep.
AutoFocus - Enum constant in enum class me.clarius.sdk.Param: Auto focus enable (default on all applications).
autoFreeze - Variable in class me.clarius.sdk.ProbeSettings: The number of seconds to engage freezing imaging after no contact mode has been engaged, valid range is 0 - 120, where 0 turns the function off.
AutoGain - Enum constant in enum class me.clarius.sdk.Param: Auto gain enable (default on for most applications).
ax - Variable in class me.clarius.sdk.PosInfo: Accelerometer x; acceleration is normalized to gravity [~9.81m/s^2] (m/s^2)/(m/s^2).
axialSize - Variable in class me.clarius.sdk.RawImageInfo: axial microns per sample.
ay - Variable in class me.clarius.sdk.PosInfo: Accelerometer y; acceleration is normalized to gravity [~9.81m/s^2] (m/s^2)/(m/s^2).
az - Variable in class me.clarius.sdk.PosInfo: Accelerometer z; acceleration is normalized to gravity [~9.81m/s^2] (m/s^2)/(m/s^2).

B

bandwidthOptimization - Variable in class me.clarius.sdk.ProbeSettings: Flag allowing the system to adjust bandwidth parameters automatically when lag or dropped frames are determined.
battery - Variable in class me.clarius.sdk.StatusInfo: Battery level in percent.
bitsPerPixel - Variable in class me.clarius.sdk.ProcessedImageInfo: bits per pixel.
bitsPerSample - Variable in class me.clarius.sdk.RawImageInfo: bits per sample.
bitsPerSample - Variable in class me.clarius.sdk.SpectralImageInfo: Bits per sample.
BMode - Enum constant in enum class me.clarius.sdk.Mode: Brightness (B) grayscale imaging mode.
bottom - Variable in class me.clarius.sdk.GateLines: Line below the active region.
bottom - Variable in class me.clarius.sdk.Tgc: Bottom tgc in dB.
Button - Enum Class in me.clarius.sdk: The probe buttons.
ButtonDisabled - Enum constant in enum class me.clarius.sdk.ButtonSetting: Disable handling.
ButtonDown - Enum constant in enum class me.clarius.sdk.Button: Down button.
ButtonFreeze - Enum constant in enum class me.clarius.sdk.ButtonSetting: Freeze/unfreeze image.
ButtonHandle - Enum constant in enum class me.clarius.sdk.Button: Handle button (custom probes only).
ButtonHoldDisabled - Enum constant in enum class me.clarius.sdk.ButtonHoldSetting: Disable handling.
ButtonHoldSetting - Enum Class in me.clarius.sdk: Button hold functions.
ButtonHoldShutdown - Enum constant in enum class me.clarius.sdk.ButtonHoldSetting: Shutdown probe.
ButtonHoldUser - Enum constant in enum class me.clarius.sdk.ButtonHoldSetting: Send interrupt through API.
ButtonOff - Enum constant in enum class me.clarius.sdk.PowerDown: User held button to shut down probe.
buttonPressed(Button, int) - Method in interface me.clarius.sdk.Solum.Listener: Button callback function.
ButtonSetting - Enum Class in me.clarius.sdk: Button functions.
ButtonUp - Enum constant in enum class me.clarius.sdk.Button: Up button.
ButtonUser - Enum constant in enum class me.clarius.sdk.ButtonSetting: Send interrupt through API.

C

CertExpired - Enum constant in enum class me.clarius.sdk.ImagingState: Cannot image due to expired certificate.
certInfo(int) - Method in interface me.clarius.sdk.Solum.Listener: Certification callback function.
charger - Variable in class me.clarius.sdk.StatusInfo: Charger status.
Charging - Enum constant in enum class me.clarius.sdk.ChargingStatus: Probe is charging.
ChargingChanged - Enum constant in enum class me.clarius.sdk.ImagingState: Probe started running or stopped due to change in charging status.
ChargingInDock - Enum constant in enum class me.clarius.sdk.PowerDown: Probe was docked in charger.
ChargingStatus - Enum Class in me.clarius.sdk: Charging status.
Chroma - Enum constant in enum class me.clarius.sdk.Param: Chroma map enable (default off).
ColorGain - Enum constant in enum class me.clarius.sdk.Param: Color/power gain in percent (default 50%).
ColorInvert - Enum constant in enum class me.clarius.sdk.Param: Color map invert (default off - red towards probe, blue away from probe).
ColorMode - Enum constant in enum class me.clarius.sdk.Mode: Color flow imaging mode (available in most workflows).
ColorPrf - Enum constant in enum class me.clarius.sdk.Param: Color/power pulse repetition frequency in kHz (default dependent on application).
ColorSteer - Enum constant in enum class me.clarius.sdk.Param: Color/power steering angle in degrees (available on linear probes, default dependent on application).
Compounding - Enum constant in enum class me.clarius.sdk.Mode: Spatial compounding mode (available in most workflows).
Config - Class in me.clarius.sdk: SDK configuration.
Config() - Constructor for class me.clarius.sdk.Config: Default constructor.
Config(LogLevel) - Constructor for class me.clarius.sdk.Config: Constructor with parameters.
connect(String, int, Optional<Long>) - Method in class me.clarius.sdk.Solum: Connect to a probe that is on the same network as the caller.
Connection - Enum Class in me.clarius.sdk: TCP connection results.
ConnectionError - Enum constant in enum class me.clarius.sdk.Connection: Connection error.
ConnectionFailed - Enum constant in enum class me.clarius.sdk.Connection: Failed to connect to probe.
connectionResult(Connection, int, String) - Method in interface me.clarius.sdk.Solum.Listener: Connection callback function.
contactDetection - Variable in class me.clarius.sdk.ProbeSettings: The number of seconds to engage a lower frame rate when no contact is detected, valid range is 0 - 30, where 0 turns the function off.

D

deepSleep - Variable in class me.clarius.sdk.ProbeSettings: The number of hours for probe to go into deep sleep, valid range is 0 - 96, where 0 disables deep sleep.
depth - Variable in class me.clarius.sdk.TgcInfo: Depth in millimeters.
disconnect() - Method in class me.clarius.sdk.Solum: Disconnect from an existing connection.
DopplerVelocity - Enum constant in enum class me.clarius.sdk.Param: 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).
down - Variable in class me.clarius.sdk.ProbeSettings: Button down setting.
downHold - Variable in class me.clarius.sdk.ProbeSettings: Button down hold setting.
DynamicRange - Enum constant in enum class me.clarius.sdk.Param: Dynamic range in percent (default 50%).

E

EcoMode - Enum constant in enum class me.clarius.sdk.Param: Eco mode enable (default off).
elements - Variable in class me.clarius.sdk.ProbeInfo: Number of probe elements.
enable5v(boolean) - Method in class me.clarius.sdk.Solum: Enable the 5V output on or off.
enableLowLevelParam(String, boolean) - Method in class me.clarius.sdk.Solum: Enable or disables a low level parameter to gain access to lower device control.
error(ErrorCode, String) - Method in interface me.clarius.sdk.Solum.Listener: Error callback function.
ErrorApplication - Enum constant in enum class me.clarius.sdk.ErrorCode: Application load error.
ErrorCode - Enum Class in me.clarius.sdk: Error codes.
ErrorGeneric - Enum constant in enum class me.clarius.sdk.ErrorCode: Generic error.
ErrorGl - Enum constant in enum class me.clarius.sdk.ErrorCode: GL error.
ErrorProbe - Enum constant in enum class me.clarius.sdk.ErrorCode: Probe error.
ErrorRawData - Enum constant in enum class me.clarius.sdk.ErrorCode: Raw data error.
ErrorSetup - Enum constant in enum class me.clarius.sdk.ErrorCode: Setup error.
ErrorSwUpdate - Enum constant in enum class me.clarius.sdk.ErrorCode: Software update error.

F

fan - Variable in class me.clarius.sdk.StatusInfo: Fan status.
FanDetected - Enum constant in enum class me.clarius.sdk.FanStatus: Fan detected.
FanRunning - Enum constant in enum class me.clarius.sdk.FanStatus: Fan running.
FanStatus - Enum Class in me.clarius.sdk: Fan status.
FLAG_OFF - Static variable in class me.clarius.sdk.ProbeSettings: Flag off.
FLAG_ON - Static variable in class me.clarius.sdk.ProbeSettings: Flag on.
FocusDepth - Enum constant in enum class me.clarius.sdk.Param: Focus depth in cm (applied when auto focus turned off).
forceLogSend - Variable in class me.clarius.sdk.ProbeSettings: Flag allowing the probe to send logs while imaging.
format - Variable in class me.clarius.sdk.ProcessedImageInfo: flag specifying the format of the image (see format definitions above).
fps - Variable in class me.clarius.sdk.ProcessedImageInfo: frame rate in hz.
fps - Variable in class me.clarius.sdk.RawImageInfo: frame rate in hz.
frameRate - Variable in class me.clarius.sdk.StatusInfo: Current imaging frame rate.

G

gain - Variable in class me.clarius.sdk.TgcInfo: Gain in decibels.
Gain - Enum constant in enum class me.clarius.sdk.Param: Gain in percent (default 50%).
GateLines - Class in me.clarius.sdk: Gate coordinates.
GateLines() - Constructor for class me.clarius.sdk.GateLines: Default constructor.
GateLines(LineF, LineF, LineF, LineF, LineF) - Constructor for class me.clarius.sdk.GateLines: Constructor with parameters.
getApplications(String, Solum.StringListResult) - Method in class me.clarius.sdk.Solum: Retrieve the available applications for a specific probe model.
getFirmwareVersion(Platform, Solum.FirmwareVersionResult) - Method in class me.clarius.sdk.Solum: Retrieve the firmware version for a given platform.
getGate(Solum.GateLinesResult) - Method in class me.clarius.sdk.Solum: Retrieve the gate for the current mode.
getLowLevelParam(String, Solum.LowLevelParamResult) - Method in class me.clarius.sdk.Solum: Retrieve a low level parameter value.
getMode(Solum.ModeResult) - Method in class me.clarius.sdk.Solum: Retrieve the current imaging mode.
getParam(Param, Solum.ParamResult) - Method in class me.clarius.sdk.Solum: Retrieve an imaging parameter value.
getProbeInfo(Solum.ProbeInfoResult) - Method in class me.clarius.sdk.Solum: Retrieve the probe info.
getProbes(Solum.StringListResult) - Method in class me.clarius.sdk.Solum: Retrieve the available probe models supported by the API.
getRange(Param, Solum.RangeResult) - Method in class me.clarius.sdk.Solum: Retrieve the range for a specific parameter.
getRoi(int, Solum.RoiResult) - Method in class me.clarius.sdk.Solum: Retrieve the ROI for the current mode if valid.
getStatus(Solum.StatusResult) - Method in class me.clarius.sdk.Solum: Retrieve the probe status.
getTgc(Solum.TgcResult) - Method in class me.clarius.sdk.Solum: Retrieve the TGC values.
guide - Variable in class me.clarius.sdk.StatusInfo: Guide status.
GuideDetected - Enum constant in enum class me.clarius.sdk.GuideStatus: Guide detected.
GuideRunning - Enum constant in enum class me.clarius.sdk.GuideStatus: Guide detected and powered.
GuideStatus - Enum Class in me.clarius.sdk: Guide status.
gx - Variable in class me.clarius.sdk.PosInfo: Gyroscope x; angular velocity is given in radians per second (RPS).
gy - Variable in class me.clarius.sdk.PosInfo: Gyroscope y; angular velocity is given in radians per second (RPS).
gz - Variable in class me.clarius.sdk.PosInfo: Gyroscope z; angular velocity is given in radians per second (RPS).

H

handle - Variable in class me.clarius.sdk.ProbeSettings: Button handle setting.
HD - Enum constant in enum class me.clarius.sdk.Platform: Second generation (HD).
HD3 - Enum constant in enum class me.clarius.sdk.Platform: Third generation (HD3).
height - Variable in class me.clarius.sdk.ProcessedImageInfo: height of the image in pixels.
htWifi - Variable in class me.clarius.sdk.ProbeSettings: Flag to enable 40 MHz bands for the probe's Wi-Fi network.

I

Idle - Enum constant in enum class me.clarius.sdk.PowerDown: Probe was idle from imaging for extended period.
ImageDepth - Enum constant in enum class me.clarius.sdk.Param: Imaging depth in cm (default dependent on application).
ImageFormat - Enum Class in me.clarius.sdk: The compression types available.
imageOnUndock - Variable in class me.clarius.sdk.ProbeSettings: Start imaging when probe comes out of charging dock.
imageSize - Variable in class me.clarius.sdk.ProcessedImageInfo: total size of image in bytes.
imaging(ImagingState, boolean) - Method in interface me.clarius.sdk.Solum.Listener: Imaging callback function.
ImagingNotReady - Enum constant in enum class me.clarius.sdk.ImagingState: Imaging is not ready, probe and application need to be loaded.
ImagingReady - Enum constant in enum class me.clarius.sdk.ImagingState: Imaging is ready.
ImagingState - Enum Class in me.clarius.sdk: Imaging state.
ImuStreaming - Enum constant in enum class me.clarius.sdk.Param: IMU streaming enable (default off).
Info - Enum constant in enum class me.clarius.sdk.LogLevel: Info level.
initialize(String, Solum.InitializationResult) - Method in class me.clarius.sdk.Solum: Initialize the Solum library to enable connection.
isConnected() - Method in class me.clarius.sdk.Solum: Check if Solum is currently connected to a probe.
isInitialized() - Method in class me.clarius.sdk.Solum: Check if Solum has been initialized.

J

jpeg - Variable in class me.clarius.sdk.RawImageInfo: size of the jpeg image, 0 if not a jpeg compressed image.
Jpeg - Enum constant in enum class me.clarius.sdk.ImageFormat: Processed images are sent as a jpeg (with header).

K

keepAwake - Variable in class me.clarius.sdk.ProbeSettings: The number of minutes to power down the device once imaging has been frozen, valid range is 0 - 120, where 0 turns the function off.
keepAwakeCharging - Variable in class me.clarius.sdk.ProbeSettings: Flag to force the probe to stay powered while being charged.

L

lateralSize - Variable in class me.clarius.sdk.RawImageInfo: lateral microns per line.
LineF - Class in me.clarius.sdk: 2D line with double precision.
LineF() - Constructor for class me.clarius.sdk.LineF: Default constructor.
LineF(PointF, PointF) - Constructor for class me.clarius.sdk.LineF: Constructor with parameters.
lines - Variable in class me.clarius.sdk.RawImageInfo: number of ultrasound lines in the image.
lines - Variable in class me.clarius.sdk.SpectralImageInfo: Number of lines in the block.
loadApplication(String, String) - Method in class me.clarius.sdk.Solum: Load an application with the given probe model.
logLevel - Variable in class me.clarius.sdk.Config: Logging level.
LogLevel - Enum Class in me.clarius.sdk: Logging level.
LowBandwidth - Enum constant in enum class me.clarius.sdk.ImagingState: Low bandwidth was detected, imaging parameters were adjusted.
LowBattery - Enum constant in enum class me.clarius.sdk.PowerDown: Low battery.

M

max - Variable in class me.clarius.sdk.Range: Maximum value.
maximizeRoi() - Method in class me.clarius.sdk.Solum: Maximize the ROI.
me.clarius.sdk - package me.clarius.sdk
mi - Variable in class me.clarius.sdk.Acoustic: mechanical index.
micronsPerPixel - Variable in class me.clarius.sdk.ProcessedImageInfo: microns per pixel (always 1:1 aspect ratio axially/laterally).
micronsPerSample - Variable in class me.clarius.sdk.SpectralImageInfo: Microns per pixel/sample in an M spectrum.
mid - Variable in class me.clarius.sdk.Tgc: Mid tgc in dB.
min - Variable in class me.clarius.sdk.Range: Minimum value.
MMode - Enum constant in enum class me.clarius.sdk.Mode: Motion (M) imaging mode.
Mode - Enum Class in me.clarius.sdk: Imaging modes.
MotionSensor - Enum constant in enum class me.clarius.sdk.ImagingState: Probe started running or stopped due to change in motion sensor.
MoveRoi - Enum constant in enum class me.clarius.sdk.RoiFunction: ROI move function (adjusts top-left).
mx - Variable in class me.clarius.sdk.PosInfo: Magnetometer x; magnetic flux density is normalized to the earth's field [~50 mT] (T/T).
my - Variable in class me.clarius.sdk.PosInfo: Magnetometer y; magnetic flux density is normalized to the earth's field [~50 mT] (T/T).
mz - Variable in class me.clarius.sdk.PosInfo: Magnetometer z; magnetic flux density is normalized to the earth's field [~50 mT] (T/T).

N

NeedleEnhance - Enum constant in enum class me.clarius.sdk.Mode: Needle enhance mode (available on linear probes).
NeedleSide - Enum constant in enum class me.clarius.sdk.Param: Needle enhance side (default 0 - LED side).
newImuDataFn(PosInfo) - Method in interface me.clarius.sdk.Solum.Listener: New imu data callback function.
newImuPortFn(int) - Method in interface me.clarius.sdk.Solum.Listener: New imu port callback function.
newProcessedImage(ByteBuffer, ProcessedImageInfo, PosInfo[]) - Method in interface me.clarius.sdk.Solum.Listener: New processed image callback function.
newRawImageFn(ByteBuffer, RawImageInfo, PosInfo[]) - Method in interface me.clarius.sdk.Solum.Listener: New raw image callback function.
newSpectralImageFn(ByteBuffer, SpectralImageInfo) - Method in interface me.clarius.sdk.Solum.Listener: New spectral image callback function.
NoContact - Enum constant in enum class me.clarius.sdk.ImagingState: Stopped imaging due to no patient contact detected.
NoFan - Enum constant in enum class me.clarius.sdk.FanStatus: No fan detected.
NoGuide - Enum constant in enum class me.clarius.sdk.GuideStatus: No guide detected.
None - Enum constant in enum class me.clarius.sdk.LogLevel: No logging.
normalBottom - Variable in class me.clarius.sdk.GateLines: Normal line below the active region.
normalTop - Variable in class me.clarius.sdk.GateLines: Normal line above the active region.
NotCharging - Enum constant in enum class me.clarius.sdk.ChargingStatus: Probe is not charging.
NoTee - Enum constant in enum class me.clarius.sdk.ImagingState: Cannot image due to tee being disconnected.

O

optimizeWifi(WifiOpt, Solum.BooleanResult) - Method in class me.clarius.sdk.Solum: Will try and optimize the wireless channel when the probe is running its own network.
originX - Variable in class me.clarius.sdk.ProcessedImageInfo: image origin in microns in the horizontal axis.
originY - Variable in class me.clarius.sdk.ProcessedImageInfo: image origin in microns in the vertical axis.
OSUpdateRequired - Enum constant in enum class me.clarius.sdk.Connection: Scanner O/S update required.
overlay - Variable in class me.clarius.sdk.ProcessedImageInfo: flag that the image is an overlay without grayscale (ie.

P

p1 - Variable in class me.clarius.sdk.LineF: First point in the line.
p2 - Variable in class me.clarius.sdk.LineF: Second point in the line.
Param - Enum Class in me.clarius.sdk: Imaging parameters.
PenetrationMode - Enum constant in enum class me.clarius.sdk.Param: Penetration mode enable (default off).
period - Variable in class me.clarius.sdk.SpectralImageInfo: Line acquisition period in seconds.
pitch - Variable in class me.clarius.sdk.ProbeInfo: Element pitch.
Platform - Enum Class in me.clarius.sdk: Major Clarius platforms.
Png - Enum constant in enum class me.clarius.sdk.ImageFormat: Processed images are sent as a png (with header).
PointF - Class in me.clarius.sdk: 2D point with double precision.
PointF() - Constructor for class me.clarius.sdk.PointF: Default constructor.
PointF(double, double) - Constructor for class me.clarius.sdk.PointF: Constructor with parameters.
PoorWifi - Enum constant in enum class me.clarius.sdk.ImagingState: Stopped imaging due to poor Wi-Fi.
PosInfo - Class in me.clarius.sdk: Positional data information structure.
PosInfo() - Constructor for class me.clarius.sdk.PosInfo: Default constructor.
PosInfo(long, double, double, double, double, double, double, double, double, double, double, double, double, double) - Constructor for class me.clarius.sdk.PosInfo: Constructor with parameters.
powerDown() - Method in class me.clarius.sdk.Solum: Try to power down the probe if actively connected.
PowerDown - Enum Class in me.clarius.sdk: Power down reason.
powerFan - Variable in class me.clarius.sdk.ProbeSettings: Flag for the ability to use the power fan.
poweringDown(PowerDown, int) - Method in interface me.clarius.sdk.Solum.Listener: Powering down callback function.
PowerMode - Enum constant in enum class me.clarius.sdk.Mode: Power Doppler imaging mode (available in most workflows, excluding cardiac).
powerOn - Variable in class me.clarius.sdk.ProbeSettings: Flag allowing the probe's buttons to power the device on.
ProbeConnected - Enum constant in enum class me.clarius.sdk.Connection: Connected to probe.
ProbeDisconnected - Enum constant in enum class me.clarius.sdk.Connection: Disconnected from probe.
ProbeInfo - Class in me.clarius.sdk: Probe information.
ProbeInfo() - Constructor for class me.clarius.sdk.ProbeInfo: Default constructor.
ProbeInfo(int, int, int, int) - Constructor for class me.clarius.sdk.ProbeInfo: Constructor with parameters.
ProbeReset - Enum Class in me.clarius.sdk: The reset commands.
ProbeSettings - Class in me.clarius.sdk: Probe settings.
ProbeSettings() - Constructor for class me.clarius.sdk.ProbeSettings: Default constructor.
ProbeSettings(int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, ButtonSetting, ButtonSetting, ButtonSetting, ButtonHoldSetting, ButtonHoldSetting) - Constructor for class me.clarius.sdk.ProbeSettings: Constructor with parameters.
ProcessedImageInfo - Class in me.clarius.sdk: Processed image information supplied with each frame.
ProcessedImageInfo() - Constructor for class me.clarius.sdk.ProcessedImageInfo: Default constructor.
ProcessedImageInfo(int, int, int, int, double, double, double, long, double, double, int, ImageFormat, TgcInfo[]) - Constructor for class me.clarius.sdk.ProcessedImageInfo: Constructor with parameters.
pw - Variable in class me.clarius.sdk.SpectralImageInfo: Flag specifying the data is PW and not M.
PwGain - Enum constant in enum class me.clarius.sdk.Param: Pulsed wave Doppler gain in [percent] (default 50%).
PwMode - Enum constant in enum class me.clarius.sdk.Mode: Pulsed wave Doppler imaging mode (available in most workflows).
PwPrf - Enum constant in enum class me.clarius.sdk.Param: Pulsed wave Doppler pulse repetition frequency in [kHz] (default dependent on application).
PwSteer - Enum constant in enum class me.clarius.sdk.Param: Pulsed wave Doppler steering angle in [degrees] (available on linear probes, default dependent on application).

Q

qw - Variable in class me.clarius.sdk.PosInfo: W component (real) of the orientation quaternion.
qx - Variable in class me.clarius.sdk.PosInfo: X component (imaginary) of the orientation quaternion.
qy - Variable in class me.clarius.sdk.PosInfo: Y component (imaginary) of the orientation quaternion.
qz - Variable in class me.clarius.sdk.PosInfo: Z component (imaginary) of the orientation quaternion.

R

radius - Variable in class me.clarius.sdk.ProbeInfo: Radius in millimeters.
Range - Class in me.clarius.sdk: Parameter range.
Range() - Constructor for class me.clarius.sdk.Range: Default constructor.
Range(double, double) - Constructor for class me.clarius.sdk.Range: Constructor with parameters.
RawBuffer - Enum constant in enum class me.clarius.sdk.Param: Raw data buffering enable (default off).
RawImageInfo - Class in me.clarius.sdk: Raw image information supplied with each frame.
RawImageInfo() - Constructor for class me.clarius.sdk.RawImageInfo: Default constructor.
RawImageInfo(int, int, int, double, double, long, int, int, double, double, TgcInfo[]) - Constructor for class me.clarius.sdk.RawImageInfo: Constructor with parameters.
readRawData(Solum.ReadRawDataCallback, Solum.Progress) - Method in class me.clarius.sdk.Solum: Retrieve raw data from a previous request.
release() - Method in class me.clarius.sdk.Solum: Unload the Solum library, any subsequent call will be no-op.
requestRawData(long, long, boolean, Solum.RequestRawDataCallback) - Method in class me.clarius.sdk.Solum: Request raw data from the probe.
requestRawDataAvailability(Solum.RequestRawDataAvailabilityCallback) - Method in class me.clarius.sdk.Solum: Request raw data availability.
ResetBattery - Enum constant in enum class me.clarius.sdk.ProbeReset: shutdown battery.
ResetCert - Enum constant in enum class me.clarius.sdk.ProbeReset: reset stored certificates.
ResetFactory - Enum constant in enum class me.clarius.sdk.ProbeReset: reset everything.
ResetKeys - Enum constant in enum class me.clarius.sdk.ProbeReset: reset handshake keys.
ResetPerformReboot - Enum constant in enum class me.clarius.sdk.ProbeReset: reboot system.
resetProbe(ProbeReset, Solum.BooleanResult) - Method in class me.clarius.sdk.Solum: Perform a probe reset.
ResetSdCard - Enum constant in enum class me.clarius.sdk.ProbeReset: sd card repair.
ResetTime - Enum constant in enum class me.clarius.sdk.ProbeReset: reset encrypted time.
ResetWifi - Enum constant in enum class me.clarius.sdk.ProbeReset: reset wifi info.
rf - Variable in class me.clarius.sdk.RawImageInfo: flag specifying data is rf and not envelope.
RfMode - Enum constant in enum class me.clarius.sdk.Mode: RF capture mode (interleaved with B).
RfStreaming - Enum constant in enum class me.clarius.sdk.Param: RF streaming enable (default on).
RoiFunction - Enum Class in me.clarius.sdk: ROI functions.
run(boolean) - Method in class me.clarius.sdk.Solum: Run or stop imaging.

S

samples - Variable in class me.clarius.sdk.RawImageInfo: number of samples per line in the image.
samples - Variable in class me.clarius.sdk.SpectralImageInfo: Number of samples per line.
separateOverlays(boolean) - Method in class me.clarius.sdk.Solum: Set a flag to separate overlays into separate images.
setCertificate(String) - Method in class me.clarius.sdk.Solum: Set the certificate for the probe with which to connect.
setFormat(ImageFormat) - Method in class me.clarius.sdk.Solum: Set the format for processed images, by default the format will be uncompressed ARGB32.
setLowLevelParam(String, double) - Method in class me.clarius.sdk.Solum: Set a low level parameter to a specific value to gain access to lower level device control.
setLowLevelPulse(String, String) - Method in class me.clarius.sdk.Solum: Set a pulse shape parameter to a specific value to gain access to lower level device control.
setMode(Mode) - Method in class me.clarius.sdk.Solum: Set an imaging mode.
setOutputSize(int, int) - Method in class me.clarius.sdk.Solum: Set the dimensions of the output display for scan conversion.
setParam(Param, double) - Method in class me.clarius.sdk.Solum: Set an imaging parameter.
setProbeSettings(ProbeSettings) - Method in class me.clarius.sdk.Solum: Set the internal probe settings to be applied upon a connection or when an existing connection exists.
setTeeExamInfo(String, String, String) - Method in class me.clarius.sdk.Solum: Set the tee exam info for a connected probe.
setTeeFn(Solum.TeeCallback) - Method in class me.clarius.sdk.Solum: Set a callback for the tee connectivity function.
setTgc(Tgc) - Method in class me.clarius.sdk.Solum: Set the TGC.
SizeRoi - Enum constant in enum class me.clarius.sdk.RoiFunction: ROI resizing function (adjusts bottom-right).
Smooth - Enum constant in enum class me.clarius.sdk.Param: Smooth range in percent (default 50%).
SoftwareShutdown - Enum constant in enum class me.clarius.sdk.PowerDown: Solum software sent shutdown command.
Solum - Class in me.clarius.sdk: Java interface for Solum.
Solum(Context, Solum.Listener) - Constructor for class me.clarius.sdk.Solum: Deprecated.
This constructor is no longer acceptable, use Solum(String, Listener) instead.
The Context object was used to obtain the path to the native JNI libraries, the new constructor lets user specify their own path if needed. The default path is: requireContext().getApplicationInfo().nativeLibraryDir.
Deprecated in version 10.3.0.
Solum(String, Config, Solum.Listener) - Constructor for class me.clarius.sdk.Solum: Load and configure the Solum library.
Solum(String, Solum.Listener) - Constructor for class me.clarius.sdk.Solum: Load the Solum library.
Solum.BooleanResult - Interface in me.clarius.sdk: Generic boolean callback.
Solum.FirmwareVersionResult - Interface in me.clarius.sdk: Firmware version callback.
Solum.GateLinesResult - Interface in me.clarius.sdk: Callback when the gate for the current mode was retrieved.
Solum.InitializationResult - Interface in me.clarius.sdk: Initialization callback.
Solum.Listener - Interface in me.clarius.sdk: Solum callbacks.
Solum.LowLevelParamResult - Interface in me.clarius.sdk: Low level param callback.
Solum.ModeResult - Interface in me.clarius.sdk: Mode callback.
Solum.ParamResult - Interface in me.clarius.sdk: Param callback.
Solum.ProbeInfoResult - Interface in me.clarius.sdk: Probe info callback.
Solum.Progress - Interface in me.clarius.sdk: Progress callback.
Solum.RangeResult - Interface in me.clarius.sdk: Range callback.
Solum.ReadRawDataCallback - Interface in me.clarius.sdk: Callback when the raw data was retrieved from the probe.
Solum.RequestRawDataAvailabilityCallback - Interface in me.clarius.sdk: Callback when the raw data availability request was completed.
Solum.RequestRawDataCallback - Interface in me.clarius.sdk: Callback when the raw data request was completed.
Solum.RoiResult - Interface in me.clarius.sdk: ROI callback.
Solum.SoftwareUpdateResult - Interface in me.clarius.sdk: Software update callback.
Solum.StatusResult - Interface in me.clarius.sdk: Status callback.
Solum.StringListResult - Interface in me.clarius.sdk: String list callback.
Solum.TeeCallback - Interface in me.clarius.sdk: Tee connection callback.
Solum.TgcResult - Interface in me.clarius.sdk: TGC callback.
sounds - Variable in class me.clarius.sdk.ProbeSettings: Flag allowing the probe to make beeping sounds.
SpectralImageInfo - Class in me.clarius.sdk: Spectral image information supplied with each block.
SpectralImageInfo() - Constructor for class me.clarius.sdk.SpectralImageInfo: Default constructor.
SpectralImageInfo(int, int, int, double, double, double, int) - Constructor for class me.clarius.sdk.SpectralImageInfo: Constructor with parameters.
stationary - Variable in class me.clarius.sdk.ProbeSettings: The number of seconds to engage freezing imaging after being stationary for a specific time frame, valid range is 0 - 120, where 0 turns the function off.
StatusInfo - Class in me.clarius.sdk: Status information.
StatusInfo() - Constructor for class me.clarius.sdk.StatusInfo: Default constructor.
StatusInfo(int, int, double, double, FanStatus, GuideStatus, ChargingStatus) - Constructor for class me.clarius.sdk.StatusInfo: Constructor with parameters.
Strain - Enum constant in enum class me.clarius.sdk.Mode: Strain elastography (available in most workflows).
StrainOpacity - Enum constant in enum class me.clarius.sdk.Param: Opacity of the strain image overlay (default 50%).
SwUpdate - Enum Class in me.clarius.sdk: Software update results.
SwUpdateBattery - Enum constant in enum class me.clarius.sdk.SwUpdate: Battery is too low to perform update.
SwUpdateCorrupt - Enum constant in enum class me.clarius.sdk.SwUpdate: Probe file system may be corrupt.
SwUpdateCurrent - Enum constant in enum class me.clarius.sdk.SwUpdate: Software is current.
SwUpdateError - Enum constant in enum class me.clarius.sdk.SwUpdate: Software update error.
SwUpdateRequired - Enum constant in enum class me.clarius.sdk.Connection: Software update required.
SwUpdateSuccess - Enum constant in enum class me.clarius.sdk.SwUpdate: Successful update.
SwUpdateUnsupported - Enum constant in enum class me.clarius.sdk.SwUpdate: Firmware being sent is no longer supported.
SyncPulse - Enum constant in enum class me.clarius.sdk.Param: Sync pulse enable (default off).

T

TeeExpired - Enum constant in enum class me.clarius.sdk.ImagingState: Cannot image due to tee being expired.
teeTimeRemaining - Variable in class me.clarius.sdk.StatusInfo: Current time remaining for tee imaging.
temperature - Variable in class me.clarius.sdk.StatusInfo: Temperature level in percent.
tgc - Variable in class me.clarius.sdk.ProcessedImageInfo: tgc points.
tgc - Variable in class me.clarius.sdk.RawImageInfo: tgc points.
Tgc - Class in me.clarius.sdk: TGC values to send to the API.
Tgc() - Constructor for class me.clarius.sdk.Tgc: Default constructor.
Tgc(double, double, double) - Constructor for class me.clarius.sdk.Tgc: Constructor with parameters.
TgcInfo - Class in me.clarius.sdk: TGC information.
TgcInfo() - Constructor for class me.clarius.sdk.TgcInfo: Default constructor.
TgcInfo(double, double) - Constructor for class me.clarius.sdk.TgcInfo: Constructor with parameters.
tib - Variable in class me.clarius.sdk.Acoustic: thermal index bone.
tic - Variable in class me.clarius.sdk.Acoustic: thermal index cranial.
tis - Variable in class me.clarius.sdk.Acoustic: thermal index soft tissue.
tm - Variable in class me.clarius.sdk.PosInfo: Timestamp in nanoseconds.
tm - Variable in class me.clarius.sdk.ProcessedImageInfo: timestamp of images.
tm - Variable in class me.clarius.sdk.RawImageInfo: timestamp of image.
TooHot - Enum constant in enum class me.clarius.sdk.PowerDown: Probe got too hot.
top - Variable in class me.clarius.sdk.GateLines: Line above the active region.
top - Variable in class me.clarius.sdk.Tgc: Top tgc in dB.
Trapezoidal - Enum constant in enum class me.clarius.sdk.Param: Trapezoidal imaging enable (available on linear probes, default off for most applications).

U

Uncompressed - Enum constant in enum class me.clarius.sdk.ImageFormat: Processed images are sent in a raw and uncompressed in 32 bits ARGB.
Uncompressed8Bit - Enum constant in enum class me.clarius.sdk.ImageFormat: Processed images are sent in a raw and uncompressed in 8 bit grayscale.
up - Variable in class me.clarius.sdk.ProbeSettings: Button up setting.
updateSoftware(String, Solum.SoftwareUpdateResult, Solum.Progress) - Method in class me.clarius.sdk.Solum: Perform a software update once connected.
updateSoftware(String, Solum.SoftwareUpdateResult, Solum.Progress, Optional<Platform>) - Method in class me.clarius.sdk.Solum: Perform a software update once connected.
upHold - Variable in class me.clarius.sdk.ProbeSettings: Button up hold setting.

V

V1 - Enum constant in enum class me.clarius.sdk.Platform: First generation.
valueOf(String) - Static method in enum class me.clarius.sdk.Button: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class me.clarius.sdk.ButtonHoldSetting: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class me.clarius.sdk.ButtonSetting: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class me.clarius.sdk.ChargingStatus: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class me.clarius.sdk.Connection: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class me.clarius.sdk.ErrorCode: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class me.clarius.sdk.FanStatus: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class me.clarius.sdk.GuideStatus: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class me.clarius.sdk.ImageFormat: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class me.clarius.sdk.ImagingState: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class me.clarius.sdk.LogLevel: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class me.clarius.sdk.Mode: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class me.clarius.sdk.Param: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class me.clarius.sdk.Platform: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class me.clarius.sdk.PowerDown: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class me.clarius.sdk.ProbeReset: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class me.clarius.sdk.RoiFunction: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class me.clarius.sdk.SwUpdate: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class me.clarius.sdk.WifiOpt: Returns the enum constant of this class with the specified name.
values() - Static method in enum class me.clarius.sdk.Button: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class me.clarius.sdk.ButtonHoldSetting: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class me.clarius.sdk.ButtonSetting: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class me.clarius.sdk.ChargingStatus: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class me.clarius.sdk.Connection: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class me.clarius.sdk.ErrorCode: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class me.clarius.sdk.FanStatus: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class me.clarius.sdk.GuideStatus: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class me.clarius.sdk.ImageFormat: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class me.clarius.sdk.ImagingState: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class me.clarius.sdk.LogLevel: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class me.clarius.sdk.Mode: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class me.clarius.sdk.Param: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class me.clarius.sdk.Platform: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class me.clarius.sdk.PowerDown: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class me.clarius.sdk.ProbeReset: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class me.clarius.sdk.RoiFunction: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class me.clarius.sdk.SwUpdate: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class me.clarius.sdk.WifiOpt: Returns an array containing the constants of this enum class, in the order they are declared.
velocityPerSample - Variable in class me.clarius.sdk.SpectralImageInfo: Velocity in m/s per pixel/sample in a PW spectrum.
version - Variable in class me.clarius.sdk.ProbeInfo: Version (1 = clarius 1st generation, 2 = clarius HD, 3 = clarius HD3).

W

wakeOnShake - Variable in class me.clarius.sdk.ProbeSettings: Flag allowing the probe to start imaging when it is picked up while frozen.
width - Variable in class me.clarius.sdk.ProcessedImageInfo: width of the image in pixels.
WifiOpt - Enum Class in me.clarius.sdk: Wireless optimization methods.
WifiOptDefault - Enum constant in enum class me.clarius.sdk.WifiOpt: Default to the production channel of 165.
wifiOptimization - Variable in class me.clarius.sdk.ProbeSettings: Flag allowing the probe to automatically freeze when poor wifi connectivity is detected.
WifiOptNext - Enum constant in enum class me.clarius.sdk.WifiOpt: Jump immediately to the next channel.
WifiOptSearch - Enum constant in enum class me.clarius.sdk.WifiOpt: Scan the surrounding networks to select the best channel (takes up to 10 seconds to search and optimize).
wifiSearch - Variable in class me.clarius.sdk.ProbeSettings: Flag to force the probe to scan the networks and choose the appropriate channel before bringing up its Wi-Fi.

X

x - Variable in class me.clarius.sdk.PointF: X coordinate.

Y

y - Variable in class me.clarius.sdk.PointF: Y coordinate.

A B C D E F G H I J K L M N O P Q R S T U V W X Y
All Classes and Interfaces|All Packages|Constant Field Values