VTK  9.5.2
Information Keys

The VTK pipeline relies on algorithms providing information about their input and output and responding to requests. More...

Functions

static vtkInformationStringKey * vtkDataObject::DATA_TYPE_NAME ()
static vtkInformationDataObjectKey * vtkDataObject::DATA_OBJECT ()
static vtkInformationIntegerKey * vtkDataObject::DATA_EXTENT_TYPE ()
static vtkInformationIntegerPointerKey * vtkDataObject::DATA_EXTENT ()
static vtkInformationIntegerVectorKey * vtkDataObject::ALL_PIECES_EXTENT ()
static vtkInformationIntegerKey * vtkDataObject::DATA_PIECE_NUMBER ()
static vtkInformationIntegerKey * vtkDataObject::DATA_NUMBER_OF_PIECES ()
static vtkInformationIntegerKey * vtkDataObject::DATA_NUMBER_OF_GHOST_LEVELS ()
static vtkInformationDoubleKey * vtkDataObject::DATA_TIME_STEP ()
static vtkInformationInformationVectorKey * vtkDataObject::POINT_DATA_VECTOR ()
static vtkInformationInformationVectorKey * vtkDataObject::CELL_DATA_VECTOR ()
static vtkInformationInformationVectorKey * vtkDataObject::VERTEX_DATA_VECTOR ()
static vtkInformationInformationVectorKey * vtkDataObject::EDGE_DATA_VECTOR ()
static vtkInformationIntegerKey * vtkDataObject::FIELD_ARRAY_TYPE ()
static vtkInformationIntegerKey * vtkDataObject::FIELD_ASSOCIATION ()
static vtkInformationIntegerKey * vtkDataObject::FIELD_ATTRIBUTE_TYPE ()
static vtkInformationIntegerKey * vtkDataObject::FIELD_ACTIVE_ATTRIBUTE ()
static vtkInformationIntegerKey * vtkDataObject::FIELD_NUMBER_OF_COMPONENTS ()
static vtkInformationIntegerKey * vtkDataObject::FIELD_NUMBER_OF_TUPLES ()
static vtkInformationIntegerKey * vtkDataObject::FIELD_OPERATION ()
static vtkInformationDoubleVectorKey * vtkDataObject::FIELD_RANGE ()
static vtkInformationIntegerVectorKey * vtkDataObject::PIECE_EXTENT ()
static vtkInformationStringKey * vtkDataObject::FIELD_NAME ()
static vtkInformationDoubleVectorKey * vtkDataObject::ORIGIN ()
static vtkInformationDoubleVectorKey * vtkDataObject::SPACING ()
static vtkInformationDoubleVectorKey * vtkDataObject::DIRECTION ()
static vtkInformationDoubleVectorKey * vtkDataObject::BOUNDING_BOX ()
static vtkInformationDataObjectKey * vtkDataObject::SIL ()
static vtkInformationIntegerKey * CONTENT_TYPE ()
 Get the (primary) property that describes the content of a selection node's data.
static vtkInformationIntegerKey * FIELD_TYPE ()
 Controls whether cell, point, or field data determine what is inside and out.
static vtkInformationDoubleKey * EPSILON ()
 For location selection of points, if distance is greater than this reject.
static vtkInformationDoubleKey * ZBUFFER_VALUE ()
 If present, closest zbuffer value of this selection.
static vtkInformationIntegerKey * CONTAINING_CELLS ()
 This flag tells the extraction filter, when FIELD_TYPE==POINT, that it should also extract the cells that contain any of the extracted points.
static vtkInformationIntegerKey * CONNECTED_LAYERS ()
 When specified, this indicates how many layers of connected elements in addition to those chosen explicitly are being selected.
static vtkInformationIntegerKey * CONNECTED_LAYERS_REMOVE_SEED ()
 When specified and also using CONNECTED_LAYERS(), this indicates if the initial selection should be kept or not.
static vtkInformationIntegerKey * CONNECTED_LAYERS_REMOVE_INTERMEDIATE_LAYERS ()
 When specified and also using CONNECTED_LAYERS(), this indicates if the intermediate layers should be kept or not.
static vtkInformationIntegerKey * COMPONENT_NUMBER ()
 When ContentType==THRESHOLDS or ContentType==VALUES i.e.
static vtkInformationIntegerKey * INVERSE ()
 This flag tells the extraction filter to exclude the selection.
static vtkInformationIntegerKey * PIXEL_COUNT ()
 A helper for visible cell selector, this is the number of pixels covered by the actor whose cells are listed in the selection.
static vtkInformationObjectBaseKey * SOURCE ()
 Pointer to the data or algorithm the selection belongs to.
static vtkInformationIntegerKey * SOURCE_ID ()
 ID of the data or algorithm the selection belongs to.
static vtkInformationObjectBaseKey * PROP ()
 Pointer to the prop the selection belongs to.
static vtkInformationIntegerKey * PROP_ID ()
 ID of the prop the selection belongs to.
static vtkInformationIntegerKey * PROCESS_ID ()
 Process id the selection is on.
static vtkInformationIntegerKey * COMPOSITE_INDEX ()
 Used to identify a node in composite datasets.
static vtkInformationIntegerKey * vtkAlgorithm::INPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements.
static vtkInformationIntegerKey * vtkAlgorithm::INPUT_IS_REPEATABLE ()
static vtkInformationInformationVectorKey * vtkAlgorithm::INPUT_REQUIRED_FIELDS ()
static vtkInformationStringVectorKey * vtkAlgorithm::INPUT_REQUIRED_DATA_TYPE ()
static vtkInformationInformationVectorKey * vtkAlgorithm::INPUT_ARRAYS_TO_PROCESS ()
static vtkInformationIntegerKey * vtkAlgorithm::INPUT_PORT ()
static vtkInformationIntegerKey * vtkAlgorithm::INPUT_CONNECTION ()
static vtkInformationIntegerKey * vtkAlgorithm::CAN_PRODUCE_SUB_EXTENT ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent.
static vtkInformationIntegerKey * vtkAlgorithm::CAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request.
static vtkInformationIntegerKey * vtkAlgorithm::ABORTED ()
static vtkInformationIntegerKey * INPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements.
static vtkInformationIntegerKey * INPUT_IS_REPEATABLE ()
static vtkInformationInformationVectorKey * INPUT_REQUIRED_FIELDS ()
static vtkInformationStringVectorKey * INPUT_REQUIRED_DATA_TYPE ()
static vtkInformationInformationVectorKey * INPUT_ARRAYS_TO_PROCESS ()
static vtkInformationIntegerKey * INPUT_PORT ()
static vtkInformationIntegerKey * INPUT_CONNECTION ()
static vtkInformationIntegerKey * CAN_PRODUCE_SUB_EXTENT ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent.
static vtkInformationIntegerKey * CAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request.
static vtkInformationIntegerKey * ABORTED ()
static vtkInformationRequestKey * vtkDemandDrivenPipeline::REQUEST_DATA_OBJECT ()
 Key defining a request to make sure the output data objects exist.
static vtkInformationRequestKey * vtkDemandDrivenPipeline::REQUEST_INFORMATION ()
 Key defining a request to make sure the output information is up to date.
static vtkInformationRequestKey * vtkDemandDrivenPipeline::REQUEST_DATA ()
 Key defining a request to make sure the output data are up to date.
static vtkInformationRequestKey * vtkDemandDrivenPipeline::REQUEST_DATA_NOT_GENERATED ()
 Key defining a request to mark outputs that will NOT be generated during a REQUEST_DATA.
static vtkInformationIntegerKey * vtkDemandDrivenPipeline::RELEASE_DATA ()
 Key to specify in pipeline information the request that data be released after it is used.
static vtkInformationIntegerKey * vtkDemandDrivenPipeline::DATA_NOT_GENERATED ()
 Key to store a mark for an output that will not be generated.
static vtkInformationExecutivePortKey * vtkExecutive::PRODUCER ()
 Information key to store the executive/port number producing an information object.
static vtkInformationExecutivePortVectorKey * vtkExecutive::CONSUMERS ()
 Information key to store the executive/port number pairs consuming an information object.
static vtkInformationIntegerKey * vtkExecutive::FROM_OUTPUT_PORT ()
 Information key to store the output port number from which a request is made.
static vtkInformationRequestKey * vtkStreamingDemandDrivenPipeline::REQUEST_UPDATE_EXTENT ()
 Key defining a request to propagate the update extent upstream.
static vtkInformationRequestKey * vtkStreamingDemandDrivenPipeline::REQUEST_UPDATE_TIME ()
 Key defining a request to propagate the update extent upstream.
static vtkInformationRequestKey * vtkStreamingDemandDrivenPipeline::REQUEST_TIME_DEPENDENT_INFORMATION ()
 Key defining a request to make sure the meta information is up to date.
static vtkInformationIntegerKey * vtkStreamingDemandDrivenPipeline::CONTINUE_EXECUTING ()
 Key for an algorithm to store in a request to tell this executive to keep executing it.
static vtkInformationIntegerKey * vtkStreamingDemandDrivenPipeline::UPDATE_EXTENT_INITIALIZED ()
 Keys to store an update request in pipeline information.
static vtkInformationIntegerVectorKey * vtkStreamingDemandDrivenPipeline::UPDATE_EXTENT ()
static vtkInformationIntegerKey * vtkStreamingDemandDrivenPipeline::UPDATE_PIECE_NUMBER ()
static vtkInformationIntegerKey * vtkStreamingDemandDrivenPipeline::UPDATE_NUMBER_OF_PIECES ()
static vtkInformationIntegerKey * vtkStreamingDemandDrivenPipeline::UPDATE_NUMBER_OF_GHOST_LEVELS ()
static vtkInformationIntegerVectorKey * vtkStreamingDemandDrivenPipeline::COMBINED_UPDATE_EXTENT ()
 Key for combining the update extents requested by all consumers, so that the final extent that is produced satisfies all consumers.
static vtkInformationIntegerVectorKey * vtkStreamingDemandDrivenPipeline::WHOLE_EXTENT ()
 Key to store the whole extent provided in pipeline information.
static vtkInformationIntegerKey * vtkStreamingDemandDrivenPipeline::UNRESTRICTED_UPDATE_EXTENT ()
 This is set if the update extent is not restricted to the whole extent, for sources that can generate an extent of any requested size.
static vtkInformationIntegerKey * vtkStreamingDemandDrivenPipeline::EXACT_EXTENT ()
 Key to specify the request for exact extent in pipeline information.
static vtkInformationDoubleVectorKey * vtkStreamingDemandDrivenPipeline::TIME_STEPS ()
 Key to store available time steps.
static vtkInformationDoubleVectorKey * vtkStreamingDemandDrivenPipeline::TIME_RANGE ()
 Key to store available time range for continuous sources.
static vtkInformationDoubleKey * vtkStreamingDemandDrivenPipeline::UPDATE_TIME_STEP ()
 Update time steps requested by the pipeline.
static vtkInformationIntegerKey * vtkStreamingDemandDrivenPipeline::TIME_DEPENDENT_INFORMATION ()
 Whether there are time dependent meta information if there is, the pipeline will perform two extra passes to gather the time dependent information.
static vtkInformationDoubleVectorKey * vtkStreamingDemandDrivenPipeline::BOUNDS ()
 key to record the bounds of a dataset.
static vtkInformationDoubleKey * vtkStreamingDemandDrivenPipeline::PREVIOUS_UPDATE_TIME_STEP ()
 Keep track of the update time request corresponding to the previous executing.
static vtkInformationIntegerKey * vtkSLACReader::IS_INTERNAL_VOLUME ()
 This key is attached to the metadata information of all data sets in the output that are part of the internal volume.
static vtkInformationIntegerKey * vtkSLACReader::IS_EXTERNAL_SURFACE ()
 This key is attached to the metadata information of all data sets in the output that are part of the external surface.
static vtkInformationIntegerKey * vtkOSPRayLightNode::IS_AMBIENT ()
 When present on light, the light acts as an ambient source.
static vtkInformationDoubleKey * vtkOSPRayLightNode::RADIUS ()
 The radius setting, when > 0.0, produces soft shadows in the path tracer.
static vtkInformationIntegerKey * vtkOSPRayRendererNode::SAMPLES_PER_PIXEL ()
 When present on renderer, controls the number of primary rays shot per pixel default is 1.
static vtkInformationDoubleKey * vtkOSPRayRendererNode::MAX_CONTRIBUTION ()
 When present on renderer, samples are clamped to this value before they are accumulated into the framebuffer default is 2.0.
static vtkInformationIntegerKey * vtkOSPRayRendererNode::MAX_DEPTH ()
 When present on renderer, controls the maximum ray recursion depth default is 20.
static vtkInformationDoubleKey * vtkOSPRayRendererNode::MIN_CONTRIBUTION ()
 When present on renderer, sample contributions below this value will be neglected to speedup rendering default is 0.01.
static vtkInformationIntegerKey * vtkOSPRayRendererNode::ROULETTE_DEPTH ()
 When present on renderer, controls the ray recursion depth at which to start Russian roulette termination default is 5.
static vtkInformationDoubleKey * vtkOSPRayRendererNode::VARIANCE_THRESHOLD ()
 When present on renderer, controls the threshold for adaptive accumulation default is 0.3.
static vtkInformationIntegerKey * vtkOSPRayRendererNode::MAX_FRAMES ()
 When present on renderer, controls the number of ospray render calls for each refresh.
static vtkInformationStringKey * vtkOSPRayRendererNode::RENDERER_TYPE ()
 Set the OSPRay renderer type to use (e.g.
static vtkInformationIntegerKey * vtkOSPRayRendererNode::AMBIENT_SAMPLES ()
 When present on renderer, controls the number of ambient occlusion samples shot per hit.
static vtkInformationDoubleKey * vtkOSPRayRendererNode::VOLUME_SAMPLING_RATE ()
 the rate of sampling for volumes, higher numbers increase the number of samples.
static vtkInformationIntegerKey * vtkOSPRayRendererNode::COMPOSITE_ON_GL ()
 used to make the renderer add ospray's content onto GL rendered content on the window
static vtkInformationDoubleVectorKey * vtkOSPRayRendererNode::NORTH_POLE ()
 World space direction of north pole for gradient and texture background.
static vtkInformationDoubleVectorKey * vtkOSPRayRendererNode::EAST_POLE ()
 World space direction of east pole for texture background.
static vtkInformationObjectBaseKey * vtkOSPRayRendererNode::MATERIAL_LIBRARY ()
 Material Library attached to the renderer.
static vtkInformationDoubleKey * vtkOSPRayRendererNode::VIEW_TIME ()
 Requested time to show in a renderer and to lookup in a temporal cache.
static vtkInformationIntegerKey * vtkOSPRayRendererNode::TIME_CACHE_SIZE ()
 Temporal cache size.
static vtkInformationIntegerKey * vtkOSPRayRendererNode::DENOISER_THRESHOLD ()
 Accumulation threshold when above which denoising kicks in.
static vtkInformationStringKey * ASSEMBLY_NAME ()
 Keys for selector-based identification of blocks to choose from a composite dataset.
static vtkInformationStringVectorKey * SELECTORS ()
 Keys for selector-based identification of blocks to choose from a composite dataset.
static vtkInformationIntegerKey * HIERARCHICAL_LEVEL ()
 Used to identify a dataset in a hiererchical box dataset.
static vtkInformationIntegerKey * HIERARCHICAL_INDEX ()
 Used to identify a dataset in a hiererchical box dataset.
static vtkInformationIntegerKey * vtkExecutive::ALGORITHM_BEFORE_FORWARD ()
 Keys to program vtkExecutive::ProcessRequest with the default behavior for unknown requests.
static vtkInformationIntegerKey * vtkExecutive::ALGORITHM_AFTER_FORWARD ()
 Keys to program vtkExecutive::ProcessRequest with the default behavior for unknown requests.
static vtkInformationIntegerKey * vtkExecutive::ALGORITHM_DIRECTION ()
 Keys to program vtkExecutive::ProcessRequest with the default behavior for unknown requests.
static vtkInformationIntegerKey * vtkExecutive::FORWARD_DIRECTION ()
 Keys to program vtkExecutive::ProcessRequest with the default behavior for unknown requests.
static vtkInformationKeyVectorKey * vtkExecutive::KEYS_TO_COPY ()
 Keys to program vtkExecutive::ProcessRequest with the default behavior for unknown requests.
static vtkInformationObjectBaseKey * vtkSLACReader::POINTS ()
 All the data sets stored in the multiblock output share the same point data.
static vtkInformationObjectBaseKey * vtkSLACReader::POINT_DATA ()
 All the data sets stored in the multiblock output share the same point data.
static vtkInformationIntegerKey * vtkOSPRayRendererNode::ENABLE_DENOISER ()
 Enable denoising (if supported).
static void vtkOSPRayRendererNode::SetEnableDenoiser (int, vtkRenderer *renderer)
 Convenience method to set/get ENABLE_DENOISER on a vtkRenderer.
static int vtkOSPRayRendererNode::GetEnableDenoiser (vtkRenderer *renderer)
 Enable denoising (if supported).

Detailed Description

The VTK pipeline relies on algorithms providing information about their input and output and responding to requests.

The information objects used to perform these actions map known keys to values. This is a list of keys that information objects use and what each key should be used for.

Function Documentation

◆ DATA_TYPE_NAME()

vtkInformationStringKey * vtkDataObject::DATA_TYPE_NAME ( )
static

◆ DATA_OBJECT()

vtkInformationDataObjectKey * vtkDataObject::DATA_OBJECT ( )
static

◆ DATA_EXTENT_TYPE()

vtkInformationIntegerKey * vtkDataObject::DATA_EXTENT_TYPE ( )
static

◆ DATA_EXTENT()

vtkInformationIntegerPointerKey * vtkDataObject::DATA_EXTENT ( )
static

◆ ALL_PIECES_EXTENT()

vtkInformationIntegerVectorKey * vtkDataObject::ALL_PIECES_EXTENT ( )
static

◆ DATA_PIECE_NUMBER()

vtkInformationIntegerKey * vtkDataObject::DATA_PIECE_NUMBER ( )
static

◆ DATA_NUMBER_OF_PIECES()

vtkInformationIntegerKey * vtkDataObject::DATA_NUMBER_OF_PIECES ( )
static

◆ DATA_NUMBER_OF_GHOST_LEVELS()

vtkInformationIntegerKey * vtkDataObject::DATA_NUMBER_OF_GHOST_LEVELS ( )
static

◆ DATA_TIME_STEP()

vtkInformationDoubleKey * vtkDataObject::DATA_TIME_STEP ( )
static

◆ POINT_DATA_VECTOR()

vtkInformationInformationVectorKey * vtkDataObject::POINT_DATA_VECTOR ( )
static

◆ CELL_DATA_VECTOR()

vtkInformationInformationVectorKey * vtkDataObject::CELL_DATA_VECTOR ( )
static

◆ VERTEX_DATA_VECTOR()

vtkInformationInformationVectorKey * vtkDataObject::VERTEX_DATA_VECTOR ( )
static

◆ EDGE_DATA_VECTOR()

vtkInformationInformationVectorKey * vtkDataObject::EDGE_DATA_VECTOR ( )
static

◆ FIELD_ARRAY_TYPE()

vtkInformationIntegerKey * vtkDataObject::FIELD_ARRAY_TYPE ( )
static

◆ FIELD_ASSOCIATION()

vtkInformationIntegerKey * vtkDataObject::FIELD_ASSOCIATION ( )
static

◆ FIELD_ATTRIBUTE_TYPE()

vtkInformationIntegerKey * vtkDataObject::FIELD_ATTRIBUTE_TYPE ( )
static

◆ FIELD_ACTIVE_ATTRIBUTE()

vtkInformationIntegerKey * vtkDataObject::FIELD_ACTIVE_ATTRIBUTE ( )
static

◆ FIELD_NUMBER_OF_COMPONENTS()

vtkInformationIntegerKey * vtkDataObject::FIELD_NUMBER_OF_COMPONENTS ( )
static

◆ FIELD_NUMBER_OF_TUPLES()

vtkInformationIntegerKey * vtkDataObject::FIELD_NUMBER_OF_TUPLES ( )
static

◆ FIELD_OPERATION()

vtkInformationIntegerKey * vtkDataObject::FIELD_OPERATION ( )
static

◆ FIELD_RANGE()

vtkInformationDoubleVectorKey * vtkDataObject::FIELD_RANGE ( )
static

◆ PIECE_EXTENT()

vtkInformationIntegerVectorKey * vtkDataObject::PIECE_EXTENT ( )
static

◆ FIELD_NAME()

vtkInformationStringKey * vtkDataObject::FIELD_NAME ( )
static

◆ ORIGIN()

vtkInformationDoubleVectorKey * vtkDataObject::ORIGIN ( )
static

◆ SPACING()

vtkInformationDoubleVectorKey * vtkDataObject::SPACING ( )
static

◆ DIRECTION()

vtkInformationDoubleVectorKey * vtkDataObject::DIRECTION ( )
static

◆ BOUNDING_BOX()

vtkInformationDoubleVectorKey * vtkDataObject::BOUNDING_BOX ( )
static

◆ SIL()

vtkInformationDataObjectKey * vtkDataObject::SIL ( )
static

◆ CONTENT_TYPE()

vtkInformationIntegerKey * CONTENT_TYPE ( )
static

Get the (primary) property that describes the content of a selection node's data.

This key takes on values from the SelectionContent enum. GetContentType() returns -1 if the content type is not set.

See also
vtkSelectionNode::SelectionContent

◆ FIELD_TYPE()

vtkInformationIntegerKey * FIELD_TYPE ( )
static

Controls whether cell, point, or field data determine what is inside and out.

The default is CELL. Vertex and edge types are also available for graph classes. GetFieldType() returns -1 if the field type is not set.

Controls whether cell, point, or field data determine what is inside and out.

If FIELD_TYPE is defined, set FieldType using accepted values as defined in vtkSelectionNode::SelectionField.

If ELEMENT_TYPE is defined, set ElementType using accepted values as defined in vtkDataObject::AttributeTypes. Note, vtkDataObject::FIELD and vtkDataObject::POINT_THEN_CELL are not supported. ELEMENT_TYPE will be converted to FIELD_TYPE, internally, since vtkSelectionNode only accepts FIELD_TYPE.

The default is FIELD_TYPE.

◆ EPSILON()

vtkInformationDoubleKey * EPSILON ( )
static

For location selection of points, if distance is greater than this reject.

◆ ZBUFFER_VALUE()

vtkInformationDoubleKey * ZBUFFER_VALUE ( )
static

If present, closest zbuffer value of this selection.

◆ CONTAINING_CELLS()

vtkInformationIntegerKey * CONTAINING_CELLS ( )
static

This flag tells the extraction filter, when FIELD_TYPE==POINT, that it should also extract the cells that contain any of the extracted points.

◆ CONNECTED_LAYERS()

vtkInformationIntegerKey * CONNECTED_LAYERS ( )
static

When specified, this indicates how many layers of connected elements in addition to those chosen explicitly are being selected.

Currently, this is only supported for cells and points.

◆ CONNECTED_LAYERS_REMOVE_SEED()

vtkInformationIntegerKey * CONNECTED_LAYERS_REMOVE_SEED ( )
static

When specified and also using CONNECTED_LAYERS(), this indicates if the initial selection should be kept or not.

◆ CONNECTED_LAYERS_REMOVE_INTERMEDIATE_LAYERS()

vtkInformationIntegerKey * CONNECTED_LAYERS_REMOVE_INTERMEDIATE_LAYERS ( )
static

When specified and also using CONNECTED_LAYERS(), this indicates if the intermediate layers should be kept or not.

◆ COMPONENT_NUMBER()

vtkInformationIntegerKey * COMPONENT_NUMBER ( )
static

When ContentType==THRESHOLDS or ContentType==VALUES i.e.

threshold and value based selections, it is possible pick the component number using this key. If none is specified, the 0th component is used. If any number less than 0 is specified, then the magnitude is used.

◆ INVERSE()

vtkInformationIntegerKey * INVERSE ( )
static

This flag tells the extraction filter to exclude the selection.

◆ PIXEL_COUNT()

vtkInformationIntegerKey * PIXEL_COUNT ( )
static

A helper for visible cell selector, this is the number of pixels covered by the actor whose cells are listed in the selection.

◆ SOURCE()

vtkInformationObjectBaseKey * SOURCE ( )
static

Pointer to the data or algorithm the selection belongs to.

◆ SOURCE_ID()

vtkInformationIntegerKey * SOURCE_ID ( )
static

ID of the data or algorithm the selection belongs to.

What ID means is application specific.

◆ PROP()

vtkInformationObjectBaseKey * PROP ( )
static

Pointer to the prop the selection belongs to.

◆ PROP_ID()

vtkInformationIntegerKey * PROP_ID ( )
static

ID of the prop the selection belongs to.

What ID means is application specific.

◆ PROCESS_ID()

vtkInformationIntegerKey * PROCESS_ID ( )
static

Process id the selection is on.

◆ ASSEMBLY_NAME()

vtkInformationStringKey * ASSEMBLY_NAME ( )
static

Keys for selector-based identification of blocks to choose from a composite dataset.

ASSEMBLY_NAME identifies the name for the assembly to use and SELECTORS provide a list of node selectors applied to the chosen assembly.

Use vtkDataAssemblyUtilities::HierarchyName as the assembly name to use the data hierarchy

◆ COMPOSITE_INDEX()

vtkInformationIntegerKey * COMPOSITE_INDEX ( )
static

Used to identify a node in composite datasets.

◆ HIERARCHICAL_LEVEL()

vtkInformationIntegerKey * HIERARCHICAL_LEVEL ( )
static

Used to identify a dataset in a hiererchical box dataset.

◆ INPUT_IS_OPTIONAL() [1/2]

vtkInformationIntegerKey * vtkAlgorithm::INPUT_IS_OPTIONAL ( )
static

Keys used to specify input port requirements.

◆ INPUT_IS_REPEATABLE() [1/2]

vtkInformationIntegerKey * vtkAlgorithm::INPUT_IS_REPEATABLE ( )
static

◆ INPUT_REQUIRED_FIELDS() [1/2]

vtkInformationInformationVectorKey * vtkAlgorithm::INPUT_REQUIRED_FIELDS ( )
static

◆ INPUT_REQUIRED_DATA_TYPE() [1/2]

vtkInformationStringVectorKey * vtkAlgorithm::INPUT_REQUIRED_DATA_TYPE ( )
static

◆ INPUT_ARRAYS_TO_PROCESS() [1/2]

vtkInformationInformationVectorKey * vtkAlgorithm::INPUT_ARRAYS_TO_PROCESS ( )
static

◆ INPUT_PORT() [1/2]

vtkInformationIntegerKey * vtkAlgorithm::INPUT_PORT ( )
static

◆ INPUT_CONNECTION() [1/2]

vtkInformationIntegerKey * vtkAlgorithm::INPUT_CONNECTION ( )
static

◆ CAN_PRODUCE_SUB_EXTENT() [1/2]

vtkInformationIntegerKey * vtkAlgorithm::CAN_PRODUCE_SUB_EXTENT ( )
static

This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent.

Many image sources and readers fall into this category but some such as the legacy structured data readers cannot support this feature.

◆ CAN_HANDLE_PIECE_REQUEST() [1/2]

vtkInformationIntegerKey * vtkAlgorithm::CAN_HANDLE_PIECE_REQUEST ( )
static

Key that tells the pipeline that a particular algorithm can or cannot handle piece request.

If a filter cannot handle piece requests and is asked for a piece, the executive will flag an error. If a structured data source cannot handle piece requests but can produce sub-extents (CAN_PRODUCE_SUB_EXTENT), the executive will use an extent translator to split the extent into pieces. Otherwise, if a source cannot handle piece requests, the executive will ask for the whole data for piece 0 and not execute the source for other pieces.

◆ ABORTED() [1/2]

vtkInformationIntegerKey * vtkAlgorithm::ABORTED ( )
static

◆ INPUT_IS_OPTIONAL() [2/2]

vtkInformationIntegerKey * RemoveNoPriorTemporalAccessInformationKey::INPUT_IS_OPTIONAL ( )
static

Keys used to specify input port requirements.

◆ INPUT_IS_REPEATABLE() [2/2]

vtkInformationIntegerKey * RemoveNoPriorTemporalAccessInformationKey::INPUT_IS_REPEATABLE ( )
static

◆ INPUT_REQUIRED_FIELDS() [2/2]

vtkInformationInformationVectorKey * RemoveNoPriorTemporalAccessInformationKey::INPUT_REQUIRED_FIELDS ( )
static

◆ INPUT_REQUIRED_DATA_TYPE() [2/2]

vtkInformationStringVectorKey * RemoveNoPriorTemporalAccessInformationKey::INPUT_REQUIRED_DATA_TYPE ( )
static

◆ INPUT_ARRAYS_TO_PROCESS() [2/2]

vtkInformationInformationVectorKey * RemoveNoPriorTemporalAccessInformationKey::INPUT_ARRAYS_TO_PROCESS ( )
static

◆ INPUT_PORT() [2/2]

vtkInformationIntegerKey * RemoveNoPriorTemporalAccessInformationKey::INPUT_PORT ( )
static

◆ INPUT_CONNECTION() [2/2]

vtkInformationIntegerKey * RemoveNoPriorTemporalAccessInformationKey::INPUT_CONNECTION ( )
static

◆ CAN_PRODUCE_SUB_EXTENT() [2/2]

vtkInformationIntegerKey * RemoveNoPriorTemporalAccessInformationKey::CAN_PRODUCE_SUB_EXTENT ( )
static

This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent.

Many image sources and readers fall into this category but some such as the legacy structured data readers cannot support this feature.

◆ CAN_HANDLE_PIECE_REQUEST() [2/2]

vtkInformationIntegerKey * RemoveNoPriorTemporalAccessInformationKey::CAN_HANDLE_PIECE_REQUEST ( )
static

Key that tells the pipeline that a particular algorithm can or cannot handle piece request.

If a filter cannot handle piece requests and is asked for a piece, the executive will flag an error. If a structured data source cannot handle piece requests but can produce sub-extents (CAN_PRODUCE_SUB_EXTENT), the executive will use an extent translator to split the extent into pieces. Otherwise, if a source cannot handle piece requests, the executive will ask for the whole data for piece 0 and not execute the source for other pieces.

◆ ABORTED() [2/2]

vtkInformationIntegerKey * RemoveNoPriorTemporalAccessInformationKey::ABORTED ( )
static

◆ REQUEST_DATA_OBJECT()

vtkInformationRequestKey * vtkDemandDrivenPipeline::REQUEST_DATA_OBJECT ( )
static

Key defining a request to make sure the output data objects exist.

◆ REQUEST_INFORMATION()

vtkInformationRequestKey * vtkDemandDrivenPipeline::REQUEST_INFORMATION ( )
static

Key defining a request to make sure the output information is up to date.

◆ REQUEST_DATA()

vtkInformationRequestKey * vtkDemandDrivenPipeline::REQUEST_DATA ( )
static

Key defining a request to make sure the output data are up to date.

◆ REQUEST_DATA_NOT_GENERATED()

vtkInformationRequestKey * vtkDemandDrivenPipeline::REQUEST_DATA_NOT_GENERATED ( )
static

Key defining a request to mark outputs that will NOT be generated during a REQUEST_DATA.

◆ RELEASE_DATA()

vtkInformationIntegerKey * vtkDemandDrivenPipeline::RELEASE_DATA ( )
static

Key to specify in pipeline information the request that data be released after it is used.

◆ DATA_NOT_GENERATED()

vtkInformationIntegerKey * vtkDemandDrivenPipeline::DATA_NOT_GENERATED ( )
static

Key to store a mark for an output that will not be generated.

Algorithms use this to tell the executive that they will not generate certain outputs for a REQUEST_DATA.

◆ PRODUCER()

vtkInformationExecutivePortKey * vtkExecutive::PRODUCER ( )
static

Information key to store the executive/port number producing an information object.

◆ CONSUMERS()

vtkInformationExecutivePortVectorKey * vtkExecutive::CONSUMERS ( )
static

Information key to store the executive/port number pairs consuming an information object.

◆ FROM_OUTPUT_PORT()

vtkInformationIntegerKey * vtkExecutive::FROM_OUTPUT_PORT ( )
static

Information key to store the output port number from which a request is made.

◆ ALGORITHM_BEFORE_FORWARD()

vtkInformationIntegerKey * vtkExecutive::ALGORITHM_BEFORE_FORWARD ( )
static

Keys to program vtkExecutive::ProcessRequest with the default behavior for unknown requests.

◆ REQUEST_UPDATE_EXTENT()

vtkInformationRequestKey * vtkStreamingDemandDrivenPipeline::REQUEST_UPDATE_EXTENT ( )
static

Key defining a request to propagate the update extent upstream.

◆ REQUEST_UPDATE_TIME()

vtkInformationRequestKey * vtkStreamingDemandDrivenPipeline::REQUEST_UPDATE_TIME ( )
static

Key defining a request to propagate the update extent upstream.

◆ REQUEST_TIME_DEPENDENT_INFORMATION()

vtkInformationRequestKey * vtkStreamingDemandDrivenPipeline::REQUEST_TIME_DEPENDENT_INFORMATION ( )
static

Key defining a request to make sure the meta information is up to date.

◆ CONTINUE_EXECUTING()

vtkInformationIntegerKey * vtkStreamingDemandDrivenPipeline::CONTINUE_EXECUTING ( )
static

Key for an algorithm to store in a request to tell this executive to keep executing it.

◆ UPDATE_EXTENT_INITIALIZED()

vtkInformationIntegerKey * vtkStreamingDemandDrivenPipeline::UPDATE_EXTENT_INITIALIZED ( )
static

Keys to store an update request in pipeline information.

◆ UPDATE_EXTENT()

vtkInformationIntegerVectorKey * vtkStreamingDemandDrivenPipeline::UPDATE_EXTENT ( )
static

◆ UPDATE_PIECE_NUMBER()

vtkInformationIntegerKey * vtkStreamingDemandDrivenPipeline::UPDATE_PIECE_NUMBER ( )
static

◆ UPDATE_NUMBER_OF_PIECES()

vtkInformationIntegerKey * vtkStreamingDemandDrivenPipeline::UPDATE_NUMBER_OF_PIECES ( )
static

◆ UPDATE_NUMBER_OF_GHOST_LEVELS()

vtkInformationIntegerKey * vtkStreamingDemandDrivenPipeline::UPDATE_NUMBER_OF_GHOST_LEVELS ( )
static

◆ COMBINED_UPDATE_EXTENT()

vtkInformationIntegerVectorKey * vtkStreamingDemandDrivenPipeline::COMBINED_UPDATE_EXTENT ( )
static

Key for combining the update extents requested by all consumers, so that the final extent that is produced satisfies all consumers.

◆ WHOLE_EXTENT()

vtkInformationIntegerVectorKey * vtkStreamingDemandDrivenPipeline::WHOLE_EXTENT ( )
static

Key to store the whole extent provided in pipeline information.

◆ UNRESTRICTED_UPDATE_EXTENT()

vtkInformationIntegerKey * vtkStreamingDemandDrivenPipeline::UNRESTRICTED_UPDATE_EXTENT ( )
static

This is set if the update extent is not restricted to the whole extent, for sources that can generate an extent of any requested size.

◆ EXACT_EXTENT()

vtkInformationIntegerKey * vtkStreamingDemandDrivenPipeline::EXACT_EXTENT ( )
static

Key to specify the request for exact extent in pipeline information.

◆ TIME_STEPS()

vtkInformationDoubleVectorKey * vtkStreamingDemandDrivenPipeline::TIME_STEPS ( )
static

Key to store available time steps.

◆ TIME_RANGE()

vtkInformationDoubleVectorKey * vtkStreamingDemandDrivenPipeline::TIME_RANGE ( )
static

Key to store available time range for continuous sources.

◆ UPDATE_TIME_STEP()

vtkInformationDoubleKey * vtkStreamingDemandDrivenPipeline::UPDATE_TIME_STEP ( )
static

Update time steps requested by the pipeline.

◆ TIME_DEPENDENT_INFORMATION()

vtkInformationIntegerKey * vtkStreamingDemandDrivenPipeline::TIME_DEPENDENT_INFORMATION ( )
static

Whether there are time dependent meta information if there is, the pipeline will perform two extra passes to gather the time dependent information.

◆ BOUNDS()

vtkInformationDoubleVectorKey * vtkStreamingDemandDrivenPipeline::BOUNDS ( )
static

key to record the bounds of a dataset.

◆ PREVIOUS_UPDATE_TIME_STEP()

vtkInformationDoubleKey * vtkStreamingDemandDrivenPipeline::PREVIOUS_UPDATE_TIME_STEP ( )
staticprotected

Keep track of the update time request corresponding to the previous executing.

If the previous update request did not correspond to an existing time step and the reader chose a time step with it's own logic, the data time step will be different than the request. If the same time step is requested again, there is no need to re-execute the algorithm. We know that it does not have this time step.

◆ IS_INTERNAL_VOLUME()

vtkInformationIntegerKey * vtkSLACReader::IS_INTERNAL_VOLUME ( )
static

This key is attached to the metadata information of all data sets in the output that are part of the internal volume.

◆ IS_EXTERNAL_SURFACE()

vtkInformationIntegerKey * vtkSLACReader::IS_EXTERNAL_SURFACE ( )
static

This key is attached to the metadata information of all data sets in the output that are part of the external surface.

◆ POINTS()

vtkInformationObjectBaseKey * vtkSLACReader::POINTS ( )
static

All the data sets stored in the multiblock output share the same point data.

For convenience, the point coordinates (vtkPoints) and point data (vtkPointData) are saved under these keys in the vtkInformation of the output data set.

◆ IS_AMBIENT()

vtkInformationIntegerKey * vtkOSPRayLightNode::IS_AMBIENT ( )
static

When present on light, the light acts as an ambient source.

An AmbientLight is one that has no specific position in space and for which only the ambient color term affects the result.

◆ RADIUS()

vtkInformationDoubleKey * vtkOSPRayLightNode::RADIUS ( )
static

The radius setting, when > 0.0, produces soft shadows in the path tracer.

◆ SAMPLES_PER_PIXEL()

vtkInformationIntegerKey * vtkOSPRayRendererNode::SAMPLES_PER_PIXEL ( )
static

When present on renderer, controls the number of primary rays shot per pixel default is 1.

◆ MAX_CONTRIBUTION()

vtkInformationDoubleKey * vtkOSPRayRendererNode::MAX_CONTRIBUTION ( )
static

When present on renderer, samples are clamped to this value before they are accumulated into the framebuffer default is 2.0.

◆ MAX_DEPTH()

vtkInformationIntegerKey * vtkOSPRayRendererNode::MAX_DEPTH ( )
static

When present on renderer, controls the maximum ray recursion depth default is 20.

◆ MIN_CONTRIBUTION()

vtkInformationDoubleKey * vtkOSPRayRendererNode::MIN_CONTRIBUTION ( )
static

When present on renderer, sample contributions below this value will be neglected to speedup rendering default is 0.01.

◆ ROULETTE_DEPTH()

vtkInformationIntegerKey * vtkOSPRayRendererNode::ROULETTE_DEPTH ( )
static

When present on renderer, controls the ray recursion depth at which to start Russian roulette termination default is 5.

◆ VARIANCE_THRESHOLD()

vtkInformationDoubleKey * vtkOSPRayRendererNode::VARIANCE_THRESHOLD ( )
static

When present on renderer, controls the threshold for adaptive accumulation default is 0.3.

◆ MAX_FRAMES()

vtkInformationIntegerKey * vtkOSPRayRendererNode::MAX_FRAMES ( )
static

When present on renderer, controls the number of ospray render calls for each refresh.

default is 1

◆ RENDERER_TYPE()

vtkInformationStringKey * vtkOSPRayRendererNode::RENDERER_TYPE ( )
static

Set the OSPRay renderer type to use (e.g.

scivis vs. pathtracer) default is scivis

◆ AMBIENT_SAMPLES()

vtkInformationIntegerKey * vtkOSPRayRendererNode::AMBIENT_SAMPLES ( )
static

When present on renderer, controls the number of ambient occlusion samples shot per hit.

default is 4

◆ VOLUME_SAMPLING_RATE()

vtkInformationDoubleKey * vtkOSPRayRendererNode::VOLUME_SAMPLING_RATE ( )
static

the rate of sampling for volumes, higher numbers increase the number of samples.

Defaults to 1.0.

◆ COMPOSITE_ON_GL()

vtkInformationIntegerKey * vtkOSPRayRendererNode::COMPOSITE_ON_GL ( )
static

used to make the renderer add ospray's content onto GL rendered content on the window

◆ NORTH_POLE()

vtkInformationDoubleVectorKey * vtkOSPRayRendererNode::NORTH_POLE ( )
static

World space direction of north pole for gradient and texture background.

◆ EAST_POLE()

vtkInformationDoubleVectorKey * vtkOSPRayRendererNode::EAST_POLE ( )
static

World space direction of east pole for texture background.

◆ MATERIAL_LIBRARY()

vtkInformationObjectBaseKey * vtkOSPRayRendererNode::MATERIAL_LIBRARY ( )
static

Material Library attached to the renderer.

◆ VIEW_TIME()

vtkInformationDoubleKey * vtkOSPRayRendererNode::VIEW_TIME ( )
static

Requested time to show in a renderer and to lookup in a temporal cache.

◆ TIME_CACHE_SIZE()

vtkInformationIntegerKey * vtkOSPRayRendererNode::TIME_CACHE_SIZE ( )
static

Temporal cache size.

◆ DENOISER_THRESHOLD()

vtkInformationIntegerKey * vtkOSPRayRendererNode::DENOISER_THRESHOLD ( )
static

Accumulation threshold when above which denoising kicks in.

◆ ENABLE_DENOISER()

vtkInformationIntegerKey * vtkOSPRayRendererNode::ENABLE_DENOISER ( )
static

Enable denoising (if supported).

◆ ALGORITHM_AFTER_FORWARD()

vtkInformationIntegerKey * vtkExecutive::ALGORITHM_AFTER_FORWARD ( )
static

Keys to program vtkExecutive::ProcessRequest with the default behavior for unknown requests.

◆ ALGORITHM_DIRECTION()

vtkInformationIntegerKey * vtkExecutive::ALGORITHM_DIRECTION ( )
static

Keys to program vtkExecutive::ProcessRequest with the default behavior for unknown requests.

◆ FORWARD_DIRECTION()

vtkInformationIntegerKey * vtkExecutive::FORWARD_DIRECTION ( )
static

Keys to program vtkExecutive::ProcessRequest with the default behavior for unknown requests.

◆ KEYS_TO_COPY()

vtkInformationKeyVectorKey * vtkExecutive::KEYS_TO_COPY ( )
static

Keys to program vtkExecutive::ProcessRequest with the default behavior for unknown requests.

◆ SetEnableDenoiser()

void vtkOSPRayRendererNode::SetEnableDenoiser ( int ,
vtkRenderer * renderer )
static

Convenience method to set/get ENABLE_DENOISER on a vtkRenderer.

◆ GetEnableDenoiser()

int vtkOSPRayRendererNode::GetEnableDenoiser ( vtkRenderer * renderer)
static

Enable denoising (if supported).

◆ POINT_DATA()

vtkInformationObjectBaseKey * vtkSLACReader::POINT_DATA ( )
static

All the data sets stored in the multiblock output share the same point data.

For convenience, the point coordinates (vtkPoints) and point data (vtkPointData) are saved under these keys in the vtkInformation of the output data set.

◆ SELECTORS()

vtkInformationStringVectorKey * SELECTORS ( )
static

Keys for selector-based identification of blocks to choose from a composite dataset.

ASSEMBLY_NAME identifies the name for the assembly to use and SELECTORS provide a list of node selectors applied to the chosen assembly.

Use vtkDataAssemblyUtilities::HierarchyName as the assembly name to use the data hierarchy

◆ HIERARCHICAL_INDEX()

vtkInformationIntegerKey * HIERARCHICAL_INDEX ( )
static

Used to identify a dataset in a hiererchical box dataset.