cinemaIO.pv_explorers Module

Module consisting of explorers and tracks that connect arbitrary paraview pipelines to cinema stores.

class paraview.cinemaIO.pv_explorers.Camera(center, axis, distance, view)[source]

Bases: paraview.cinemaIO.explorers.Track

A track that connects a ParaView script’s camera to the phi and theta tracks. This allows the creation of spherical camera stores where the user can view the data from many points around it.

execute(document)[source]

moves camera into position for the current phi, theta value

class paraview.cinemaIO.pv_explorers.Clip(argument, clip)[source]

Bases: paraview.cinemaIO.explorers.Track

A track that connects a clip filter to a scalar valued parameter.

execute(doc)[source]
prepare(explorer)[source]
class paraview.cinemaIO.pv_explorers.Color(parameter, colorlist, rep)[source]

Bases: paraview.cinemaIO.explorers.Track

A track that connects a parameter to color controls.

execute(doc)[source]

tells ParaView to color the object we’ve been assigned using the color definition we’ve been given that corresponds to the value we’ve been assigned to watch in the doc.descriptor

class paraview.cinemaIO.pv_explorers.ColorList[source]

A helper that creates a dictionary of color controls for ParaView. The Color track takes in a color name from the Explorer and looks up into a ColorList to determine exactly what needs to be set to apply the color.

AddDepth(name)[source]
AddLUT(name, lut)[source]
AddLuminance(name)[source]
AddSolidColor(name, RGB)[source]
AddValueRender(name, field, arrayname, component, range)[source]
getColor(name)[source]
class paraview.cinemaIO.pv_explorers.Contour(parameter, filt)[source]

Bases: paraview.cinemaIO.explorers.Track

A track that connects a contour filter to a scalar valued parameter.

execute(doc)[source]
prepare(explorer)[source]
class paraview.cinemaIO.pv_explorers.ImageExplorer(cinema_store, parameters, tracks, view=None, iSave=True)[source]

Bases: paraview.cinemaIO.explorers.Explorer

An Explorer that connects a ParaView script’s views to a store. Basically it iterates over the parameters and for each unique combination it tells ParaView to make an image and saved the result into the store.

captureWindowAsNumpy()[source]
captureWindowRGB()[source]
enableFloatValues(enable)[source]
finish()[source]
insert(document)[source]

overridden to use paraview to generate an image and create a the document for it

setDrawMode(choice, **kwargs)[source]

helper for Color tracks so that they can cause ParaView to render in the right mode.

class paraview.cinemaIO.pv_explorers.PoseCamera(view, camType, store)[source]

Bases: paraview.cinemaIO.explorers.Track

A track that connects a ParaView script’s pose track which has 3x3 camera orientations in it. Also takes in camera_eye, _at and _up arrays, which designate the initial position at each timestep, from which the camera moves according to each pose.

execute(document)[source]

moves camera into position for the current phi, theta value

class paraview.cinemaIO.pv_explorers.Slice(parameter, filt)[source]

Bases: paraview.cinemaIO.explorers.Track

A track that connects a slice filter to a scalar valued parameter.

execute(doc)[source]
prepare(explorer)[source]
class paraview.cinemaIO.pv_explorers.SourceProxyInLayer(parameter, representation)[source]

Bases: paraview.cinemaIO.explorers.LayerControl

A track that turns on and off an source proxy in a layer

hideme()[source]
showme()[source]
class paraview.cinemaIO.pv_explorers.Templated(parameter, filt, methodName)[source]

Bases: paraview.cinemaIO.explorers.Track

A track that connects any type of filter to a scalar valued parameter. To use pass in a source proxy (aka filter) and the name of method (aka property) to be called on it.

execute(doc)[source]
class paraview.cinemaIO.pv_explorers.ValueMode[source]
FLOATING_POINT = 2
INVERTIBLE_LUT = 1
paraview.cinemaIO.pv_explorers.printView(view)[source]