Index (Clarius Cast API Reference for Android)

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

A

accept(boolean) - Method in interface me.clarius.sdk.Cast.BooleanResult: Called with the request result.
accept(boolean, int, boolean) - Method in interface me.clarius.sdk.Cast.ConnectionResult: Called with the request result.
accept(int) - Method in interface me.clarius.sdk.Cast.RequestRawDataCallback: Called with the request result.
accept(int) - Method in interface me.clarius.sdk.Cast.StartCaptureResult: Called with the request result.
accept(int, ByteBuffer) - Method in interface me.clarius.sdk.Cast.ReadRawDataCallback: Called with the request result.
accept(Optional<String>) - Method in interface me.clarius.sdk.Cast.FirmwareVersionResult: Called with the request result.
accept(Optional<ProbeInfo>) - Method in interface me.clarius.sdk.Cast.ProbeInfoResult: Called with the request result.
addImageOverlay(int, byte[], int, int, float, float, float, float) - Method in class me.clarius.sdk.Cast: Add an image overlay to a started capture
addLabelOverlay(int, String, double, double, double, double) - Method in class me.clarius.sdk.Cast: Add a label overlay to a started capture
addMeasurement(long, int, MeasurementType, String, PointF[]) - Method in class me.clarius.sdk.Cast: Add a measurement to a started capture
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.
AutoGain - Enum constant in enum class me.clarius.sdk.UserFunction: Toggle auto gain.
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

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.UserFunction: Enter B mode.
Button - Enum Class in me.clarius.sdk: The probe buttons.
ButtonDown - Enum constant in enum class me.clarius.sdk.Button: Down button.
ButtonHandle - Enum constant in enum class me.clarius.sdk.Button: Handle button (custom probes only).
buttonPressed(Button, int) - Method in interface me.clarius.sdk.Cast.Listener: Button callback function.
ButtonUp - Enum constant in enum class me.clarius.sdk.Button: Up button.

C

CaptureCine - Enum constant in enum class me.clarius.sdk.UserFunction: Capture cine.
CaptureImage - Enum constant in enum class me.clarius.sdk.UserFunction: Capture still image.
Cast - Class in me.clarius.sdk: Java interface for Clarius Cast.
Cast(Context, Cast.Listener) - Constructor for class me.clarius.sdk.Cast: Load the Clarius Cast library.
Cast.BooleanResult - Interface in me.clarius.sdk: Boolean result callback.
Cast.ConnectionResult - Interface in me.clarius.sdk: Connection callback.
Cast.FirmwareVersionResult - Interface in me.clarius.sdk: Firmware version callback.
Cast.Listener - Interface in me.clarius.sdk: Clarius Cast callbacks.
Cast.ProbeInfoResult - Interface in me.clarius.sdk: Probe info callback.
Cast.ReadRawDataCallback - Interface in me.clarius.sdk: Callback when the raw data was retrieved from the probe.
Cast.RequestRawDataCallback - Interface in me.clarius.sdk: Callback when the raw data request was completed.
Cast.StartCaptureResult - Interface in me.clarius.sdk: Capture creation callback.
CenterGuide - Enum constant in enum class me.clarius.sdk.UserFunction: Toggle center guide.
ColorDoppler - Enum constant in enum class me.clarius.sdk.UserFunction: Enter color Doppler mode.
connect(String, int, Optional<Long>, String, Cast.ConnectionResult) - Method in class me.clarius.sdk.Cast: Connect to a probe that is on the same network as the caller.
CusMeasurementTypeDistance - Enum constant in enum class me.clarius.sdk.MeasurementType: point-to-point distance.
CusMeasurementTypeTraceArea - Enum constant in enum class me.clarius.sdk.MeasurementType: trace area.
CusMeasurementTypeTraceDistance - Enum constant in enum class me.clarius.sdk.MeasurementType: trace distance.

D

depth - Variable in class me.clarius.sdk.TgcInfo: Depth in millimeters.
DepthDec - Enum constant in enum class me.clarius.sdk.UserFunction: Decrease depth.
DepthInc - Enum constant in enum class me.clarius.sdk.UserFunction: Increase depth.
disconnect(Cast.BooleanResult) - Method in class me.clarius.sdk.Cast: Disconnect from an existing connection.

E

elements - Variable in class me.clarius.sdk.ProbeInfo: Number of probe elements.
error(String) - Method in interface me.clarius.sdk.Cast.Listener: Error callback function.

F

finishCapture(int, Cast.BooleanResult) - Method in class me.clarius.sdk.Cast: Finish a previously started capture and send it to the app.
Flip - Enum constant in enum class me.clarius.sdk.UserFunction: Toggle horizontal flip.
format - Variable in class me.clarius.sdk.ProcessedImageInfo: Flag specifying the format of the image (see format definitions above).
freeze(boolean) - Method in interface me.clarius.sdk.Cast.Listener: Freeze callback function.
Freeze - Enum constant in enum class me.clarius.sdk.UserFunction: Toggle freeze.
FullScreen - Enum constant in enum class me.clarius.sdk.UserFunction: Toggle full screen.

G

gain - Variable in class me.clarius.sdk.TgcInfo: Gain in decibels.
GainDec - Enum constant in enum class me.clarius.sdk.UserFunction: Increase gain.
GainInc - Enum constant in enum class me.clarius.sdk.UserFunction: Decrease gain.
getFirmwareVersion(Platform, Cast.FirmwareVersionResult) - Method in class me.clarius.sdk.Cast: Retrieve the firmware version for a given platform.
getProbeInfo(Cast.ProbeInfoResult) - Method in class me.clarius.sdk.Cast: Retrieve the probe info.
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

HD - Enum constant in enum class me.clarius.sdk.Platform: Second generation.
HD3 - Enum constant in enum class me.clarius.sdk.Platform: Third generation.
height - Variable in class me.clarius.sdk.ProcessedImageInfo: Height of the image in pixels.

I

ImageFormat - Enum Class in me.clarius.sdk: Image formats.
imageSize - Variable in class me.clarius.sdk.ProcessedImageInfo: Total size of image in bytes.
initialize(String, Cast.BooleanResult) - Method in class me.clarius.sdk.Cast: Initialize the Clarius Cast library to enable connection.
isConnected() - Method in class me.clarius.sdk.Cast: Check if Clarius Cast is currently connected to a probe.
isInitialized() - Method in class me.clarius.sdk.Cast: Check if Clarius Cast 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.

L

lateralSize - Variable in class me.clarius.sdk.RawImageInfo: Lateral microns per line.
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.

M

me.clarius.sdk - package me.clarius.sdk
MeasurementType - Enum Class in me.clarius.sdk: Supported measurement types.
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.
MMode - Enum constant in enum class me.clarius.sdk.UserFunction: Enter M mode.
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.UserFunction: Enter needle enhance mode (when available).
NeedleSide - Enum constant in enum class me.clarius.sdk.UserFunction: Toggle needle enhance side.
newProcessedImage(ByteBuffer, ProcessedImageInfo, PosInfo[]) - Method in interface me.clarius.sdk.Cast.Listener: New processed image callback function.
newRawImageFn(ByteBuffer, RawImageInfo, PosInfo[]) - Method in interface me.clarius.sdk.Cast.Listener: New raw image callback function.
newSpectralImageFn(ByteBuffer, SpectralImageInfo) - Method in interface me.clarius.sdk.Cast.Listener: New spectral image callback function.

O

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.
overlay - Variable in class me.clarius.sdk.ProcessedImageInfo: Flag that the image is an overlay without grayscale (ie.

P

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.
PlayCine - Enum constant in enum class me.clarius.sdk.UserFunction: Play cine when frozen.
Png - Enum constant in enum class me.clarius.sdk.ImageFormat: Processed images are sent as a png.
PointF - Class in me.clarius.sdk: Point with X and Y coordinates 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.
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.
PowerDoppler - Enum constant in enum class me.clarius.sdk.UserFunction: Enter power Doppler mode.
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.
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, int, ImageFormat, TgcInfo[]) - Constructor for class me.clarius.sdk.ProcessedImageInfo: Constructor with parameters.
progress(int) - Method in interface me.clarius.sdk.Cast.Listener: Progress callback function.
pw - Variable in class me.clarius.sdk.SpectralImageInfo: Flag specifying the data is PW and not M.
PwDoppler - Enum constant in enum class me.clarius.sdk.UserFunction: Enter pulsed wave Doppler mode (when available).

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.
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, TgcInfo[]) - Constructor for class me.clarius.sdk.RawImageInfo: Constructor with parameters.
readRawData(Cast.ReadRawDataCallback) - Method in class me.clarius.sdk.Cast: Retrieve raw data from a previous request.
release() - Method in class me.clarius.sdk.Cast: Unload the Clarius Cast library, any subsequent call will be no-op.
requestRawData(long, long, Cast.RequestRawDataCallback) - Method in class me.clarius.sdk.Cast: Request raw data from the probe.
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.UserFunction: Enter rf mode (when available).

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.Cast: Set a flag to separate overlays into separate images.
SetDepth - Enum constant in enum class me.clarius.sdk.UserFunction: Set depth in cm.
setFormat(ImageFormat) - Method in class me.clarius.sdk.Cast: Set the format for processed images, by default the format will be uncompressed ARGB32.
SetGain - Enum constant in enum class me.clarius.sdk.UserFunction: Set gain in %.
setOutputSize(int, int) - Method in class me.clarius.sdk.Cast: Set the dimensions of the output display for scan conversion.
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.
startCapture(long, Cast.StartCaptureResult) - Method in class me.clarius.sdk.Cast: Create a capture request locally for sending to the app.
Strain - Enum constant in enum class me.clarius.sdk.UserFunction: Enter strain elastography mode (when available).

T

tgc - Variable in class me.clarius.sdk.ProcessedImageInfo: TGC points.
tgc - Variable in class me.clarius.sdk.RawImageInfo: TGC points.
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.
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.

U

Uncompressed - Enum constant in enum class me.clarius.sdk.ImageFormat: Processed images are sent in a raw and uncompressed in 32 bits ARGB.
userFunction(UserFunction, double, Cast.BooleanResult) - Method in class me.clarius.sdk.Cast: Perform a user function on a connected probe.
UserFunction - Enum Class in me.clarius.sdk: The possible user functions from a button, foot pedal, or listener.

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.ImageFormat: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class me.clarius.sdk.MeasurementType: 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.UserFunction: 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.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.MeasurementType: 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.UserFunction: 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).
VoiceCommand - Enum constant in enum class me.clarius.sdk.UserFunction: Toggle voice commands.

W

width - Variable in class me.clarius.sdk.ProcessedImageInfo: Width of the image in pixels.

X

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

Y

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

Z

Zoom - Enum constant in enum class me.clarius.sdk.UserFunction: Toggle zoom.

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