org.autoplot.ScriptContext2023

ScriptContext provides the API to perform abstract functions with the application. For example,

{@code
 ScriptContext.load('https://autoplot.org/data/somedata.dat')
 ScriptContext.writeToPdf('/tmp/foo.pdf')
}

PNG_KEY_SCRIPT

The name of the script which results in the image, optionally with its arguments.

PNG_KEY_VAP

The Autoplot .vap file which results in the image, optionally with "?" and modifiers.

PNG_KEY_URI

The Autoplot URI which results in the image.

_setOutputStream

resets the output stream. This method is used internally, do not use this routine.

Parameters

Returns:

addBottomDecoration

add code that will paint custom graphics on the canvas or on a plot. The command will be invoked after all other painting is done, making the decoration to be on top. Note plots can only have one decoration, and the Canvas can have any number. Calling reset() will remove all decorations.

def paint(g):
    g.color= Color.BLUE
    for i in xrange(0,1000,100):
        g.drawOval(500-i/2,500-i/2,i,i)

addBottomDecoration( dom.canvases[0], paint )

Parameters

Returns:

See Also:

addMouseModule

add code that will respond to mouse events. This will receive an event following the mouse release when a box is dragged out.

def boxLookup( evt ):
    showMessageDialog( "start: (%s,%s)
finish: (%s,%s)" %
        ( evt.getStartX(), evt.getStartY(), 
        evt.getFinishX(), evt.getFinishY() ) )
  
addMouseModule( dom.plots[0], 'Box Lookup', boxLookup )   

Parameters

Returns:

See Also:

addPlotElement

"overplot" by adding another PlotElement to the plot and setting the data to this PlotElement.

Parameters

Returns:

See Also:

addPlots

adds a block of plots to the canvas below the focus plot. A plotElement is added for each plot as well.

Parameters

Returns:

addTab

add a tab to the running application. A new tab will be added with the label, with the component added within a scroll pane.

Parameters

Returns:

See Also:

addTopDecoration

add code that will paint custom graphics on the canvas or on a plot. The command will be invoked after all other painting is done, making the decoration to be on top. Note plots can only have one decoration, and the Canvas can have any number. Calling reset() will remove all decorations.

def paint(g):
    for i in xrange(0,1000,100):
        g.drawOval(500-i/2,500-i/2,i,i)

addTopDecoration( dom.canvases[0], paint )

Parameters

Returns:

See Also:

alert

show a popup that you know the user will see. Note HTML code will work.

Parameters

Returns:

bind

binds two bean properties together. Bindings are bidirectional, but the initial copy is from src to dst. In MVC terms, src should be the model and dst should be a view. The properties must fire property change events for the binding mechanism to work. As of v2014a_10, if the src is a DomNode and a child of the application, then use dom.getController().bind so that the vap will contain the binding. Example:

 model= getApplicationModel()
 bind( model.getPlotDefaults(), "title", model.getPlotDefaults().getXAxis(), "label" )

Parameters

Returns:

See Also:

bindGuiSafe

binds two bean properties together. Bindings are bidirectional, but the initial copy is from src to dst. In MVC terms, src should be the model and dst should be a view. The properties must fire property change events for the binding mechanism to work. As of v2014a_10, if the src is a DomNode and a child of the application, then use dom.getController().bind so that the vap will contain the binding. Example:

 model= getApplicationModel()
 bind( model.getPlotDefaults(), "title", model.getPlotDefaults().getXAxis(), "label" )

Parameters

Returns:

See Also:

createApplicationModel

return a new dom in a minimal Autoplot application. Use result.getCanvas() to get the DasCanvas which can be added to other components.

report= createApplicationModel()
addTab( 'report', report.canvas )
report.setDataSet(linspace(0,1,101))

Parameters

Returns:

createDataPointRecorder

return a component which can be used to accumulate data. This is typically inserted into its own tab with the addTab command. This is set to sort data in X as it comes in, and this can be disabled with setSorted(False)

dpr= createDataPointRecorder()
addTab( 'digitizer', dpr )

Returns:

See Also:

createGui

create a model with a GUI presentation layer. If the GUI is already created, then this does nothing.

Returns:

dumpToDas2Stream

serializes the dataset to a das2stream, a well-documented, open, streaming data format. (that's a joke.) Das2Streams are the legacy stream format used by the Plasma Wave Groups's server, and can serialize a limited set of QDataSets. QStreams were introduced to allow streaming of any QDataSet, see dumpToQStream. Currently, to keep the channel open, the stream is created in a buffer and then the buffer is sent. TODO: write a stream-producing code that doesn't close the output stream. (TODO: does it still do this?)

Parameters

Returns:

dumpToQStream

serializes the dataset to a QStream, a self-documenting, streaming format useful for moving datasets.

ds= getDataSet('http://autoplot.org/data/somedata.cdf?BGSEc')
from java.lang import System
dumpToQStream( ds, System.out, True )
 

Parameters

Returns:

fixLayout

make the layout more efficient by removing empty spaces and overlapping plots.

Returns:

formatDataSet

Export the data into a format implied by the filename extension. See the export data dialog for additional parameters available for formatting. For example:

 ds= getDataSet('http://autoplot.org/data/somedata.cdf?BGSEc')
 formatDataSet( ds, 'vap+dat:file:/home/jbf/temp/foo.dat?tformat=minutes&format=6.2f')

Parameters

Returns:

generateTimeRanges

Given a spec to format timeranges and a range to contain each timerange, produce a list of all timeranges covering the range formatted with the spec. For example, generateTimeRanges( "%Y-%m-%d", "Jun 2009" ) would result in 2009-06-01, 2009-06-02, ..., 2009-06-30.

Parameters

Returns:

getApplication

return the focus application.

Returns:

getApplicationModel

returns the internal application model (the object that does all the business). This provides access to the internal model for power users. Note the applicationModel provides limited access, and the DOM now provides full access to the application.

Returns:

getCompletions

return a list of completions. This is useful in the IDL context as well as Jython scripts. This will perform the completion for where the carot is at the end of the string. Only completions where maybePlot indicates the URI is now valid are returned, so for example https://autoplot.org/data/somedata.cdf?noDep is not returned and https://autoplot.org/data/somedata.cdf?Magnitude is. Note this is included to continue support as this is described in https://autoplot.org/developer.idlMatlab.

Parameters

Returns:

getDocumentModel

get the document model (DOM). This may initialize the model, in which case defaults like the cache directory are set.

Returns:

getInstance

Returns:

getTimeRangesFor

return an array of URLs that match the spec for the time range provided. For example,

  uri= 'http://cdaweb.gsfc.nasa.gov/istp_public/data/polar/hyd_h0/$Y/po_h0_hyd_$Y$m$d_v01.cdf?ELECTRON_DIFFERENTIAL_ENERGY_FLUX'
  xx= getTimeRangesFor( uri, '2000-jan', '$Y-$d-$m' )
  for x in xx:
    print x
 

Parameters

Returns:

getViewWindow

return the Window for the application, to be used for dialogs. See createGui(), which creates the view.

Returns:

getWindow

return the internal handle for the window and dom within.

Returns:

isModelInitialized

provide way to see if the model is already initialized (e.g. for clone application)

Returns:

load

load the .vap file. This is implemented by calling plot on the URI.

Parameters

Returns:

loadVap

load a vap from a file and return the dom.

Parameters

Returns:

See Also:

makeColorTable

returns a color table with the given name. If the name is already registered, then the registered colortable is returned. using QDataSets as inputs to make it easier to use in scripts.

Parameters

Returns:

See Also:

mkdir

make the directory. This must be a local file right now, but may start with "file://"

Parameters

Returns:

newApplication

get or create the application identified by the name. For example:

ds= ripples(20,20)
plot( 0, ds )
sliceWindow= newApplication('slice')
setApplication(sliceWindow)
plot( slice0(ds,0) ) 
 

Parameters

Returns:

newDialogWindow

return a new Autoplot.

Parameters

Returns:

newWindow

create a new window with the given location and size.

Parameters

Returns:

See Also:

peekAt

This is intended to be used with a debugger. The developer should put a breakpoint at the out.write statement, and then call peekAt from the script.

Parameters

Returns:

plot

bring up the autoplot with the specified URL. Note the URI is resolved asynchronously, so errors thrown during the load cannot be caught here. See getDataSet to load data synchronously.

Parameters

Returns:

reset

reset the application to its initial state.

Returns:

save

save the current state as a vap file

Parameters

Returns:

saveVap

save the application dom to a file.

Parameters

Returns:

See Also:

setApplication

set the current application for commands. For example, to have two windows plotting data, you would:

 plot([1,2,3])
 popup=newWindow('popup')
 setWindow(popup)
 plot([3,2,1])
 

Parameters

Returns:

See Also:

setApplicationModel

set the focus for scripts.

Parameters

Returns:

See Also:

setCanvasSize

set the size of the canvas. This is only used when the GUI is not used, and in headless mode, otherwise the GUI controls the size of the canvas.

Parameters

Returns:

setDataSourceURL

set the internal model's url to surl. The data set will be loaded, and writeToPng and writeToSvg can be used in headless mode.

Parameters

Returns:

setDefaultApplication

reset the script focus to the default application.

Returns:

setLayout

make a stack plot.

Parameters

Returns:

setLayoutOverplot

make a single plot with so many plot elements.

Parameters

Returns:

See Also:

setRenderStyle

Set the style used to render the data using a string identifier: spectrogram, series, scatter, histogram, fill_to_zero, digital

Parameters

Returns:

setStatus

set the Autoplot status bar string. Use the prefixes "busy:", "warning:" and "error:" to set icons.

Parameters

Returns:

See Also:

setTitle

set the title of the plot.

Parameters

Returns:

setWindow

Set the application model. This is the simplest Autoplot implementation existing, where there are no buttons, etc.

Parameters

Returns:

See Also:

setWindowLocation

set the window location

Parameters

Returns:

showMessageDialog

show a popup to the scientist, which they must acknowledge before this returns.

Parameters

Returns:

See Also:

sleep

sleep for so many milliseconds. This is introduced to avoid the import, which makes running scripts securely non-trivial.

Parameters

Returns:

unbind

unbind the property

Parameters

Returns:

waitUntilIdle

wait until the application is idle. This does a model.waitUntilIdle, but also checks for the DataSetSelector for pending operations.

Returns:

writeToBufferedImage

creates a BufferedImage from the provided DOM. This blocks until the image is ready.

Parameters

Returns:

writeToPdf

write out the current canvas to a pdf file. TODO: this has issues with the size. See writeToPng(filename). It looks like this might be handled here Note for relative references, this will use the Java process present working directory (PWD) instead of the PWD variable found in scripts

Parameters

Returns:

writeToPng

write out the current canvas to a png file. TODO: bug 557: this has issues with the size. It's coded to get the size from the DOM, but if it is fitted and has a container it must get size from the container. Use writeToPng( filename, width, height ) instead for now. See writeToPdf(String filename), which appears to have a fix for this that would affect how this is resolved. Note for relative references, this will use the Java process present working directory (PWD) instead of the PWD variable found in scripts

Parameters

Returns:

writeToSvg

write out the current canvas to a svg file. Note for relative references, this will use the Java process present working directory (PWD) instead of the PWD variable found in scripts

Parameters

Returns: