## org.autoplot.idlsupport.QDataSetBridge

See http://autoplot.org/IDL and http://autoplot.org/Matlab which show how this is used in the environments.

## PROP_FILTER

## clearFillValue

clearFillValue( ) → void

don't use fill value.

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc]

## clearMemory

clearMemory( ) → void

clear existing data from memory, in case the bridge object is not cleared from in IDL or Matlab memory.

### Returns:

void (returns nothing)

### See Also:

reportMemory()
[search for examples] [view on GitHub] [view on old javadoc]

## clearPreferredUnits

clearPreferredUnits( ) → void

clear any preference for units.

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc]

## depend

depend( int dim ) → String

### Parameters

dim - an int

### Returns:

java.lang.String
[search for examples] [view on GitHub] [view on old javadoc]

## doGetDataSet

doGetDataSet( ) → void

performs the read. Note no progress status is available and this blocks until the read is done. doGetDataSet(mon) should be called if progress is needed. 2011-01-01: getStatus or getStatusMessage should be called afterwards to check the result of the load, this will no longer throw an exception.

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc]

## doGetDataSet

doGetDataSet( ProgressMonitor mon ) → void

This initiates the read on a separate thread, so this does not block and should be used with caution. See getProgressMonitor for use. Note this is more advanced and is intended to support use in other software (e.g. PaPCo). Note because there is one exception that is stored, a QDataSetBridge object is only able to load one dataset at a time. Simultaneous loads should be done with multiple QDataSetBridge objects.

### Parameters

mon - progress monitor from getProgressMonitor()

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc]

## dumpStack

Deprecated: this is no longer a problem and will be removed

## dumpStackInNSeconds

Deprecated: this is no longer a problem and will be removed

## freeMemory

freeMemory( ) → int[]

return the total memory and free memory available to the Java process, in megabytes (1e6 bytes).

### Returns:

an integer array [ used, total ]
[search for examples] [view on GitHub] [view on old javadoc]

## getException

getException( ) → java.lang.Exception

return the Exception from the last doGetDataSet call.

### Returns:

a java.lang.Exception
[search for examples] [view on GitHub] [view on old javadoc]

## getFilter

getFilter( ) → String

get the filter that is applied to the data immediately after it is loaded.

### Returns:

the filter string, empty string means no filters.
[search for examples] [view on GitHub] [view on old javadoc]

## getProgressMonitor

getProgressMonitor( ) → ProgressMonitor

returns an object that can be used to monitor the progress of a download. mon= qds->getProgressMonitor(); qds->doGetDataSet( mon ) while ( ! mon->isFinished() ) do begin print, strtrim( mon->getTaskProgress(), 2 ) + " " + strtrim( mon->getTaskSize(), 2 ) wait, 0.2 ; don't overload the thread endwhile

### Returns:

a ProgressMonitor
[search for examples] [view on GitHub] [view on old javadoc]

## getQDataSet

getQDataSet( ) → QDataSet

provides direct access to the loaded dataset, used when the caller knows how to use a QDataSet.

### Returns:

a QDataSet
[search for examples] [view on GitHub] [view on old javadoc]

## getQDataSet

getQDataSet( String name ) → QDataSet

provides direct access to the loaded dataset, used when the caller knows how to use a QDataSet.

### Parameters

name - a String

### Returns:

a QDataSet
[search for examples] [view on GitHub] [view on old javadoc]

## getStatus

getStatus( ) → int

returns 0 for last get operation successful

### Returns:

an int
[search for examples] [view on GitHub] [view on old javadoc]

## getStatusMessage

getStatusMessage( ) → String

returns "" for last operation successful, or non-empty indicating the problem. Note getException will return the Java exception for deeper inspection.

### Returns:

"" or the error message
[search for examples] [view on GitHub] [view on old javadoc]

## hasProperty

hasProperty( String name, String propname, int i ) → boolean

### Parameters

name - a String
propname - a String
i - an int

### Returns:

boolean
[search for examples] [view on GitHub] [view on old javadoc]
hasProperty( String name, String propname ) → boolean [view source]
hasProperty( String propname ) → boolean [view source]
hasProperty( String propname, int i ) → boolean [view source]

## isQube

isQube( ) → boolean

### Returns:

boolean
[search for examples] [view on GitHub] [view on old javadoc]

## labelsAlias

labelsAlias( String name, String[] result ) → void

get the string values of the data instead of the numbers. This provides a means to decode times and nominal data such as labels data sets.

### Parameters

name - a String
result - a java.lang.String[]

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc]

## length

length( String name ) → int

return the length of the zeroth dimension of the dataset

### Parameters

name - a String

### Returns:

the length of the zeroth dimension
[search for examples] [view on GitHub] [view on old javadoc]

## length

length( ) → int

return the length of the zeroth dimension of the main dataset.

### Returns:

the length of the zeroth dimension
[search for examples] [view on GitHub] [view on old javadoc]

## lengths

lengths( String name ) → int[]

return the lengths of the dimensions of the specified dataset.

### Parameters

name - a String

### Returns:

an int[]
[search for examples] [view on GitHub] [view on old javadoc]

## lengths

lengths( ) → int[]

return the lengths of the dimensions of the default dataset.

### Returns:

an int[]
[search for examples] [view on GitHub] [view on old javadoc]

## lengths

lengths( String name, int i ) → int[]

return the lengths of the dimensions of the named dataset, once sliced at index i.

### Parameters

name - a String
i - the index to slice

### Returns:

an int[]

### See Also:

length() length which returns the length of the zeroth index.
[search for examples] [view on GitHub] [view on old javadoc]

## lengths

lengths( int i ) → int[]

return the lengths of the dimensions of the main dataset, once sliced at index i.

### Parameters

i - the index to slice

### Returns:

the lengths of each dimension.
[search for examples] [view on GitHub] [view on old javadoc]

## name

name( ) → String

### Returns:

java.lang.String
[search for examples] [view on GitHub] [view on old javadoc]

## nameFor

nameFor( QDataSet dep0 ) → String

return the name used to refer to the dataset. This may add to the list of datasets.

### Parameters

dep0 - the dataset

### Returns:

the name for the dataset.
[search for examples] [view on GitHub] [view on old javadoc]

## names

names( ) → String[]

### Returns:

java.lang.String[]
[search for examples] [view on GitHub] [view on old javadoc]

## plane

plane( int iplane ) → String

### Parameters

iplane - an int

### Returns:

java.lang.String
[search for examples] [view on GitHub] [view on old javadoc]

## properties

properties( String name, int i ) → java.util.Map

get the properties for the named dataset

### Parameters

name - a String
i - the index

### Returns:

a java.util.Map
[search for examples] [view on GitHub] [view on old javadoc]

## properties

properties( String name ) → java.util.Map

get the properties for the named dataset

### Parameters

name - a String

### Returns:

a java.util.Map
[search for examples] [view on GitHub] [view on old javadoc]
properties( ) → java.util.Map [view source]
properties( int i ) → java.util.Map [view source]

## property

property( String name, String propname, int i ) → Object

returns one of String, int, double, float, int[], double, float[]

### Parameters

name - a String
propname - a String
i - an int

### Returns:

the property
[search for examples] [view on GitHub] [view on old javadoc]

## property

property( String name, String propname ) → Object

returns one of String, int, double, float, int[], double, float[]

### Parameters

name - a String
propname - a String

### Returns:

an Object
[search for examples] [view on GitHub] [view on old javadoc]

## property

property( String propname ) → Object

returns one of String, int, double, float, int[], double, float[]

### Parameters

propname - a String

### Returns:

an Object
[search for examples] [view on GitHub] [view on old javadoc]

## property

property( String propname, int i ) → Object

returns one of String, int, double, float, int[], double, float[]

### Parameters

propname - the property name
i - the slice index

### Returns:

the name of the qdataset, or the value.
[search for examples] [view on GitHub] [view on old javadoc]

## propertyAsDouble

propertyAsDouble( String property ) → double

### Parameters

property - a String

### Returns:

double
[search for examples] [view on GitHub] [view on old javadoc]
propertyAsDouble( String name, String property ) → double [view source]

## propertyAsString

propertyAsString( String property ) → String

return the default dataset property value as a string.

### Parameters

property - property name

### Returns:

a String
[search for examples] [view on GitHub] [view on old javadoc]

## propertyAsString

propertyAsString( String name, String property ) → String

return the property value as a string.

### Parameters

name - dataset name
property - property name like "UNITS" or "LABEL"

### Returns:

a String
[search for examples] [view on GitHub] [view on old javadoc]

## rank

rank( String name ) → int

return the number of dimensions of the specified dataset.

### Parameters

name - a String

### Returns:

an int
[search for examples] [view on GitHub] [view on old javadoc]

## rank

rank( ) → int

return the number of dimensions of the default dataset.

### Returns:

an int
[search for examples] [view on GitHub] [view on old javadoc]

## readLogConfiguration

readLogConfiguration( ) → void

load the configuration from autoplot_data/config/logging.properties

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc]

## reportMemory

reportMemory( ) → void

print the Java memory stats to stderr.

### Returns:

void (returns nothing)

### See Also:

clearMemory()
[search for examples] [view on GitHub] [view on old javadoc]

## setDebug

setDebug( boolean debug ) → void

turn on/off debug messages

### Parameters

debug - a boolean

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc]

## setFillDouble

setFillDouble( double d ) → void

set the value to return when the data is invalid, when the data is known to be stored as doubles (8-byte numbers). Python JPype doesn't allow for operator overloading, so this should be used.

### Parameters

d - a double

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc]

## setFillValue

setFillValue( double d ) → void

set the value to return when the data is invalid. Note in IDL, where I echoed which was being called: IDL> apds.setFillValue, 89. % setFillValue(float) IDL> apds.setFillValue, 89.d % setFillValue(double)

### Parameters

d - a double

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc]
setFillValue( float f ) → void [view source]

## setFilter

setFilter( String filter ) → void

set the filter that is applied to the data immediately after it is loaded.

### Parameters

filter - filter string like "|histogram()" or "" for no filters.

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc]

## setPreferredUnits

setPreferredUnits( String sunit ) → void

set the preferred units for the data. The code will convert to these units when a converter is found. If a preference is indicated when it is convertible to an existing preference, the existing preference is removed. See clearPreferredUnits to remove all preferences. Example units strings (capitalization matters):

>         seconds since 2010-01-01T00:00
>         days since 2010-01-01T00:00
>         Hz
>         kHz
>         MHz

### Parameters

sunit - a String

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc]

## slice

slice( String name, int i, double[] result ) → void

accessor for non-qube

### Parameters

name - a String
i - an int
result - a double[]

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc]

## slice

slice( String name, int i, double[][] result ) → void

accessor for non-qube

### Parameters

name - a String
i - an int
result - a double[][]

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc]
slice( String name, int i, double[][][] result ) → void [view source]
slice( int i, double[] result ) → void [view source]
slice( int i, double[][] result ) → void [view source]
slice( int i, double[][][] result ) → void [view source]

## slice

slice( String name, int i ) → Object

return the i-th 1 or 2-D array of doubles or floats containing the values in the specified rank 2 or 3 dataset. This is to support non-qube datasets.

### Parameters

name - a String
i - an int

### Returns:

an Object
[search for examples] [view on GitHub] [view on old javadoc]

## slice

slice( int i0 ) → Object

return an 1,2,or 3-D array of doubles or floats containing the values in a slice on the zeroth dimension of the default dataset.

### Parameters

i0 - the index to slice on.

### Returns:

1,2,or 3-D array of doubles or floats.
[search for examples] [view on GitHub] [view on old javadoc]

## slice1

slice1( int index ) → Object

slice on the first dimension, which is useful for extracting data component by component.

### Parameters

index - an int

### Returns:

array of floats or doubles.
[search for examples] [view on GitHub] [view on old javadoc]
slice1( int index, String name ) → Object [view source]

## svalues

svalues( String name, String[] result ) → void

### Parameters

name - a String
result - a java.lang.String[]

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc]
svalues( String[] result ) → void [view source]

## svalues

svalues( ) → String[]

return a array of strings, which can be useful for data discovery, for a rank 1 dataset.

### Returns:

a string array.
[search for examples] [view on GitHub] [view on old javadoc]

## svalues

svalues( String name ) → String[]

return a array of strings, which can be useful for data discovery, for a rank 1 dataset.

### Parameters

name - the dataset name, such as "Epoch"

### Returns:

a string array.
[search for examples] [view on GitHub] [view on old javadoc]

## values

values( String name, double[] result ) → void

### Parameters

name - a String
result - a double[]

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc]
values( String name, double[][] result ) → void [view source]
values( String name, double[][][] result ) → void [view source]
values( String name, double[][][][] result ) → void [view source]
values( double[] result ) → void [view source]
values( double[][] result ) → void [view source]
values( double[][][] result ) → void [view source]
values( double[][][][] result ) → void [view source]

## values

values( ) → Object

return an 1,2,or 3-D array of doubles or floats containing the values in the default dataset.

### Returns:

an Object
[search for examples] [view on GitHub] [view on old javadoc]

## values

values( String name ) → Object

return an 1,2,or 3-D array of doubles or floats containing the values in the specified dataset.

### Parameters

name - a String

### Returns:

an Object
[search for examples] [view on GitHub] [view on old javadoc]

## valuesAlias

valuesAlias( String name, double[] result ) → void

copy the data into a 1-D array. Rank 2 and 3 dataset array are then aliased with the highest dimension the most tightly packed.

### Parameters

name - a String
result - a double[]

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc]