discretize.mixins.vtkModule.vtkXMLStructuredGridWriter¶

class discretize.mixins.vtkModule.vtkXMLStructuredGridWriter¶

Bases: vtkIOXMLPython.vtkXMLStructuredDataWriter

vtkXMLStructuredGridWriter - Write VTK XML StructuredGrid files.

Superclass: vtkXMLStructuredDataWriter

vtkXMLStructuredGridWriter writes the VTK XML StructuredGrid file format. One structured grid input can be written into one file in any number of streamed pieces. The standard extension for this writer’s file format is “vts”. This writer is also used to write a single piece of the parallel file format.

@sa vtkXMLPStructuredGridWriter

Attributes¶

vtkXMLStructuredGridWriter.AbortExecuteOff¶

virtual void AbortExecuteOff()

Set/Get the AbortExecute flag for the process object. Process objects may handle premature termination of execution in different ways.

Type:	C++

vtkXMLStructuredGridWriter.AbortExecuteOn¶

virtual void AbortExecuteOn()

Set/Get the AbortExecute flag for the process object. Process objects may handle premature termination of execution in different ways.

Type:	C++

vtkXMLStructuredGridWriter.AddInputConnection¶

virtual void AddInputConnection(int port,: vtkAlgorithmOutput *input)

V.AddInputConnection(vtkAlgorithmOutput) C++: virtual void AddInputConnection(vtkAlgorithmOutput *input)

Add a connection to the given input port index. See SetInputConnection() for details on input connections. This method is the complement to RemoveInputConnection() in that it adds only the connection specified without affecting other connections. Typical usage is

filter2->AddInputConnection(0, filter1->GetOutputPort(0)).

Type:	C++

vtkXMLStructuredGridWriter.AddInputDataObject¶

virtual void AddInputDataObject(int port,: vtkDataObject *data)

V.AddInputDataObject(vtkDataObject) C++: virtual void AddInputDataObject(vtkDataObject *data)

Add the data-object as an input to this given port. This will add a new input connection on the specified port without affecting any existing connections on the same input port.

Type:	C++

vtkXMLStructuredGridWriter.AddObserver¶

unsigned long AddObserver(const char *event,: vtkCommand *command, float priority=0.0f)

Add an event callback function(vtkObject, int) for an event type. Returns a handle that can be used with RemoveEvent(int).

Type:	C++

vtkXMLStructuredGridWriter.Appended = 2¶

vtkXMLStructuredGridWriter.Ascii = 0¶

vtkXMLStructuredGridWriter.BigEndian = 0¶

vtkXMLStructuredGridWriter.Binary = 1¶

vtkXMLStructuredGridWriter.BreakOnError¶

static void BreakOnError()

This method is called when vtkErrorMacro executes. It allows the debugger to break on error.

Type:	C++

vtkXMLStructuredGridWriter.CAN_HANDLE_PIECE_REQUEST¶

static vtkInformationIntegerKey *CAN_HANDLE_PIECE_REQUEST()

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.ingroup InformationKeys

Type:	C++

vtkXMLStructuredGridWriter.CAN_PRODUCE_SUB_EXTENT¶

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. Many image sources and readers fall into this category but some such as the legacy structured data readers cannot support this feature.ingroup InformationKeys

Type:	C++

vtkXMLStructuredGridWriter.ConvertTotalInputToPortConnection¶

void ConvertTotalInputToPortConnection(int ind, int &port,: int &conn)

Convenience routine to convert from a linear ordering of input connections to a port/connection pair.

Type:	C++

vtkXMLStructuredGridWriter.DEFAULT_PRECISION = 2¶

vtkXMLStructuredGridWriter.DOUBLE_PRECISION = 1¶

vtkXMLStructuredGridWriter.DebugOff¶

virtual void DebugOff()

Turn debugging output off.

Type:	C++

vtkXMLStructuredGridWriter.DebugOn¶

virtual void DebugOn()

Turn debugging output on.

Type:	C++

vtkXMLStructuredGridWriter.EncodeAppendedDataOff¶

virtual void EncodeAppendedDataOff()

Get/Set whether the appended data section is base64 encoded. If encoded, reading and writing will be slower, but the file will be fully valid XML and text-only. If not encoded, the XML specification will be violated, but reading and writing will be fast. The default is to do the encoding.

Type:	C++

vtkXMLStructuredGridWriter.EncodeAppendedDataOn¶

virtual void EncodeAppendedDataOn()

Get/Set whether the appended data section is base64 encoded. If encoded, reading and writing will be slower, but the file will be fully valid XML and text-only. If not encoded, the XML specification will be violated, but reading and writing will be fast. The default is to do the encoding.

Type:	C++

vtkXMLStructuredGridWriter.FastDelete¶

virtual void FastDelete()

Delete a reference to this object. This version will not invoke garbage collection and can potentially leak the object if it is part of a reference loop. Use this method only when it is known that the object has another reference and would not be collected if a full garbage collection check were done.

Type:	C++

vtkXMLStructuredGridWriter.GetAbortExecute¶

virtual int GetAbortExecute()

Set/Get the AbortExecute flag for the process object. Process objects may handle premature termination of execution in different ways.

Type:	C++

vtkXMLStructuredGridWriter.GetAddressAsString¶

const char *GetAddressAsString()

Get address of C++ object in format ‘Addr=%p’ after casting to the specified type. You can get the same information from o.__this__.

Type:	C++

vtkXMLStructuredGridWriter.GetBlockSize¶

virtual size_t GetBlockSize()

Get/Set the block size used in compression. When reading, this controls the granularity of how much extra information must be read when only part of the data are requested. The value should be a multiple of the largest scalar data type.

Type:	C++

vtkXMLStructuredGridWriter.GetByteOrder¶

virtual int GetByteOrder()

Get/Set the byte order of data written to the file. The default is the machine’s hardware byte order.

Type:	C++

vtkXMLStructuredGridWriter.GetClassName¶

const char *GetClassName()

Return the class name as a string.

Type:	C++

vtkXMLStructuredGridWriter.GetCommand¶

vtkCommand *GetCommand(unsigned long tag)

Allow people to add/remove/invoke observers (callbacks) to any VTK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and a vtkCommand to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. When events are invoked, the observers are called in the order they were added. If a priority value is specified, then the higher priority commands are called first. A command may set an abort flag to stop processing of the event. (See vtkCommand.h for more information.)

Type:	C++

vtkXMLStructuredGridWriter.GetCompressor¶

virtual vtkDataCompressor *GetCompressor()

Get/Set the compressor used to compress binary and appended data before writing to the file. Default is a vtkZLibDataCompressor.

Type:	C++

vtkXMLStructuredGridWriter.GetDataMode¶

virtual int GetDataMode()

Get/Set the data mode used for the file’s data. The options are vtkXMLWriter::Ascii, vtkXMLWriter::Binary, and vtkXMLWriter::Appended.

Type:	C++

vtkXMLStructuredGridWriter.GetDebug¶

bool GetDebug()

Get the value of the debug flag.

Type:	C++

vtkXMLStructuredGridWriter.GetDefaultFileExtension¶

const char *GetDefaultFileExtension() override;

Get the default file extension for files written by this writer.

Type:	C++

vtkXMLStructuredGridWriter.GetEncodeAppendedData¶

virtual int GetEncodeAppendedData()

Get/Set whether the appended data section is base64 encoded. If encoded, reading and writing will be slower, but the file will be fully valid XML and text-only. If not encoded, the XML specification will be violated, but reading and writing will be fast. The default is to do the encoding.

Type:	C++

vtkXMLStructuredGridWriter.GetErrorCode¶

virtual unsigned long GetErrorCode()

The error code contains a possible error that occurred while reading or writing the file.

Type:	C++

vtkXMLStructuredGridWriter.GetExecutive¶

vtkExecutive *GetExecutive()

Get this algorithm’s executive. If it has none, a default executive will be created.

Type:	C++

vtkXMLStructuredGridWriter.GetFileName¶

virtual char *GetFileName()

Get/Set the name of the output file.

Type:	C++

vtkXMLStructuredGridWriter.GetGhostLevel¶

virtual int GetGhostLevel()

Get/Set the ghost level used to pad each piece.

Type:	C++

vtkXMLStructuredGridWriter.GetGlobalWarningDisplay¶

static int GetGlobalWarningDisplay()

This is a global flag that controls whether any debug, warning or error messages are displayed.

Type:	C++

vtkXMLStructuredGridWriter.GetHeaderType¶

virtual int GetHeaderType()

Get/Set the binary data header word type. The default is UInt32. Set to UInt64 when storing arrays requiring 64-bit indexing.

Type:	C++

vtkXMLStructuredGridWriter.GetIdType¶

virtual int GetIdType()

Get/Set the size of the vtkIdType values stored in the file. The default is the real size of vtkIdType.

Type:	C++

vtkXMLStructuredGridWriter.GetInformation¶

virtual vtkInformation *GetInformation()

Set/Get the information object associated with this algorithm.

Type:	C++

vtkXMLStructuredGridWriter.GetInput¶

vtkStructuredGrid *GetInput()

Get/Set the writer’s input.

Type:	C++

vtkXMLStructuredGridWriter.GetInputAlgorithm¶

vtkAlgorithm *GetInputAlgorithm(int port, int index,: int &algPort)

V.GetInputAlgorithm(int, int) -> vtkAlgorithm C++: vtkAlgorithm *GetInputAlgorithm(int port, int index) V.GetInputAlgorithm() -> vtkAlgorithm C++: vtkAlgorithm *GetInputAlgorithm()

Returns the algorithm and the output port index of that algorithm connected to a port-index pair.

Type:	C++

vtkXMLStructuredGridWriter.GetInputArrayInformation¶

vtkInformation *GetInputArrayInformation(int idx)

Get the info object for the specified input array to this algorithm

Type:	C++

vtkXMLStructuredGridWriter.GetInputConnection¶

vtkAlgorithmOutput *GetInputConnection(int port, int index)

Get the algorithm output port connected to an input port.

Type:	C++

vtkXMLStructuredGridWriter.GetInputDataObject¶

vtkDataObject *GetInputDataObject(int port, int connection)

Get the data object that will contain the algorithm input for the given port and given connection.

Type:	C++

vtkXMLStructuredGridWriter.GetInputExecutive¶

vtkExecutive *GetInputExecutive(int port, int index) V.GetInputExecutive() -> vtkExecutive C++: vtkExecutive *GetInputExecutive()

Returns the executive associated with a particular input connection.

Type:	C++

vtkXMLStructuredGridWriter.GetInputInformation¶

vtkInformation *GetInputInformation(int port, int index) V.GetInputInformation() -> vtkInformation C++: vtkInformation *GetInputInformation()

Return the information object that is associated with a particular input connection. This can be used to get meta-data coming from the REQUEST_INFORMATION pass and set requests for the REQUEST_UPDATE_EXTENT pass. NOTE: Do not use this in any of the pipeline passes. Use the information objects passed as arguments instead.

Type:	C++

vtkXMLStructuredGridWriter.GetInputPortInformation¶

vtkInformation *GetInputPortInformation(int port)

Get the information object associated with an input port. There is one input port per kind of input to the algorithm. Each input port tells executives what kind of data and downstream requests this algorithm can handle for that input.

Type:	C++

vtkXMLStructuredGridWriter.GetMTime¶

virtual vtkMTimeType GetMTime()

Return this object’s modified time.

Type:	C++

vtkXMLStructuredGridWriter.GetNumberOfInputConnections¶

int GetNumberOfInputConnections(int port)

Get the number of inputs currently connected to a port.

Type:	C++

vtkXMLStructuredGridWriter.GetNumberOfInputPorts¶

int GetNumberOfInputPorts()

Get the number of input ports used by the algorithm.

Type:	C++

vtkXMLStructuredGridWriter.GetNumberOfOutputPorts¶

int GetNumberOfOutputPorts()

Get the number of output ports provided by the algorithm.

Type:	C++

vtkXMLStructuredGridWriter.GetNumberOfPieces¶

virtual int GetNumberOfPieces()

Get/Set the number of pieces used to stream the image through the pipeline while writing to the file.

Type:	C++

vtkXMLStructuredGridWriter.GetNumberOfTimeSteps¶

virtual int GetNumberOfTimeSteps()

Set the number of time steps

Type:	C++

vtkXMLStructuredGridWriter.GetOutputDataObject¶

vtkDataObject *GetOutputDataObject(int port)

Get the data object that will contain the algorithm output for the given port.

Type:	C++

vtkXMLStructuredGridWriter.GetOutputInformation¶

vtkInformation *GetOutputInformation(int port)

Return the information object that is associated with a particular output port. This can be used to set meta-data coming during the REQUEST_INFORMATION. NOTE: Do not use this in any of the pipeline passes. Use the information objects passed as arguments instead.

Type:	C++

vtkXMLStructuredGridWriter.GetOutputPort¶

vtkAlgorithmOutput *GetOutputPort(int index) V.GetOutputPort() -> vtkAlgorithmOutput C++: vtkAlgorithmOutput *GetOutputPort()

Get a proxy object corresponding to the given output port of this algorithm. The proxy object can be passed to another algorithm’s SetInputConnection(), AddInputConnection(), and RemoveInputConnection() methods to modify pipeline connectivity.

Type:	C++

vtkXMLStructuredGridWriter.GetOutputPortInformation¶

vtkInformation *GetOutputPortInformation(int port)

Get the information object associated with an output port. There is one output port per output from the algorithm. Each output port tells executives what kind of upstream requests this algorithm can handle for that output.

Type:	C++

vtkXMLStructuredGridWriter.GetOutputString¶

std::string GetOutputString()

Enable writing to an OutputString instead of the default, a file.

Type:	C++

vtkXMLStructuredGridWriter.GetProgress¶

virtual double GetProgress()

Set/Get the execution progress of a process object.

Type:	C++

vtkXMLStructuredGridWriter.GetProgressMaxValue¶

virtual double GetProgressMaxValue()

Set/Get the execution progress of a process object.

Type:	C++

vtkXMLStructuredGridWriter.GetProgressMinValue¶

virtual double GetProgressMinValue()

Set/Get the execution progress of a process object.

Type:	C++

vtkXMLStructuredGridWriter.GetProgressObserver¶

virtual vtkProgressObserver *GetProgressObserver()

If an ProgressObserver is set, the algorithm will report progress through it rather than directly. This means that it will call UpdateProgress() on the ProgressObserver rather than itself report it and set progress. This is most useful in situations where multiple threads are executing an algorithm at the same time and want to handle progress locally.

Type:	C++

vtkXMLStructuredGridWriter.GetProgressText¶

virtual char *GetProgressText()

Set the current text message associated with the progress state. This may be used by a calling process/GUI. Note: Because SetProgressText() is called from inside RequestData() it does not modify the algorithm object. Algorithms are not allowed to modify themselves from inside RequestData().

Type:	C++

vtkXMLStructuredGridWriter.GetReferenceCount¶

int GetReferenceCount()

Return the current reference count of this object.

Type:	C++

vtkXMLStructuredGridWriter.GetReleaseDataFlag¶

virtual int GetReleaseDataFlag()

Turn release data flag on or off for all output ports.

Type:	C++

vtkXMLStructuredGridWriter.GetTotalNumberOfInputConnections¶

int GetTotalNumberOfInputConnections()

Get the total number of inputs for this algorithm

Type:	C++

vtkXMLStructuredGridWriter.GetUpdateExtent¶

int *GetUpdateExtent() V.GetUpdateExtent(int) -> (int, int, int, int, int, int) C++: int *GetUpdateExtent(int port) V.GetUpdateExtent(int, int, int, int, int, int) C++: void GetUpdateExtent(int &x0, int &x1, int &y0, int &y1,

int &z0, int &z1)

V.GetUpdateExtent(int, int, int, int, int, int, int) C++: void GetUpdateExtent(int port, int &x0, int &x1, int &y0,

int &y1, int &z0, int &z1)

V.GetUpdateExtent([int, int, int, int, int, int]) C++: void GetUpdateExtent(int extent[6]) V.GetUpdateExtent(int, [int, int, int, int, int, int]) C++: void GetUpdateExtent(int port, int extent[6])

These functions return the update extent for output ports that use 3D extents. Where port is not specified, it is assumed to be 0.

Type:	C++

vtkXMLStructuredGridWriter.GetUpdateGhostLevel¶

int GetUpdateGhostLevel() V.GetUpdateGhostLevel(int) -> int C++: int GetUpdateGhostLevel(int port)

These functions return the update extent for output ports that use piece extents. Where port is not specified, it is assumed to be 0.

Type:	C++

vtkXMLStructuredGridWriter.GetUpdateNumberOfPieces¶

int GetUpdateNumberOfPieces() V.GetUpdateNumberOfPieces(int) -> int C++: int GetUpdateNumberOfPieces(int port)

These functions return the update extent for output ports that use piece extents. Where port is not specified, it is assumed to be 0.

Type:	C++

vtkXMLStructuredGridWriter.GetUpdatePiece¶

int GetUpdatePiece() V.GetUpdatePiece(int) -> int C++: int GetUpdatePiece(int port)

These functions return the update extent for output ports that use piece extents. Where port is not specified, it is assumed to be 0.

Type:	C++

vtkXMLStructuredGridWriter.GetWriteExtent¶

int *GetWriteExtent()

Type:	C++

vtkXMLStructuredGridWriter.GetWritePiece¶

virtual int GetWritePiece()

Get/Set the piece to write to the file. If this is negative, all pieces will be written.

Type:	C++

vtkXMLStructuredGridWriter.GetWriteToOutputString¶

virtual int GetWriteToOutputString()

Enable writing to an OutputString instead of the default, a file.

Type:	C++

vtkXMLStructuredGridWriter.GlobalWarningDisplayOff¶

static void GlobalWarningDisplayOff()

This is a global flag that controls whether any debug, warning or error messages are displayed.

Type:	C++

vtkXMLStructuredGridWriter.GlobalWarningDisplayOn¶

static void GlobalWarningDisplayOn()

This is a global flag that controls whether any debug, warning or error messages are displayed.

Type:	C++

vtkXMLStructuredGridWriter.HasExecutive¶

int HasExecutive()

Check whether this algorithm has an assigned executive. This will NOT create a default executive.

Type:	C++

vtkXMLStructuredGridWriter.HasObserver¶

int HasObserver(unsigned long event, vtkCommand *) V.HasObserver(string, vtkCommand) -> int C++: int HasObserver(const char *event, vtkCommand *) V.HasObserver(int) -> int C++: int HasObserver(unsigned long event) V.HasObserver(string) -> int C++: int HasObserver(const char *event)

Allow people to add/remove/invoke observers (callbacks) to any VTK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and a vtkCommand to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. When events are invoked, the observers are called in the order they were added. If a priority value is specified, then the higher priority commands are called first. A command may set an abort flag to stop processing of the event. (See vtkCommand.h for more information.)

Type:	C++

vtkXMLStructuredGridWriter.INPUT_ARRAYS_TO_PROCESS¶

static vtkInformationInformationVectorKey *INPUT_ARRAYS_TO_PROCESS(: )

ingroup InformationKeys

Type:	C++

vtkXMLStructuredGridWriter.INPUT_CONNECTION¶

static vtkInformationIntegerKey *INPUT_CONNECTION()

ingroup InformationKeys

Type:	C++

vtkXMLStructuredGridWriter.INPUT_IS_OPTIONAL¶

static vtkInformationIntegerKey *INPUT_IS_OPTIONAL()

Keys used to specify input port requirements.ingroup InformationKeys

Type:	C++

vtkXMLStructuredGridWriter.INPUT_IS_REPEATABLE¶

static vtkInformationIntegerKey *INPUT_IS_REPEATABLE()

ingroup InformationKeys

Type:	C++

vtkXMLStructuredGridWriter.INPUT_PORT¶

static vtkInformationIntegerKey *INPUT_PORT()

ingroup InformationKeys

Type:	C++

vtkXMLStructuredGridWriter.INPUT_REQUIRED_DATA_TYPE¶

static vtkInformationStringVectorKey *INPUT_REQUIRED_DATA_TYPE(: )

ingroup InformationKeys

Type:	C++

vtkXMLStructuredGridWriter.INPUT_REQUIRED_FIELDS¶

static vtkInformationInformationVectorKey *INPUT_REQUIRED_FIELDS(: )

ingroup InformationKeys

Type:	C++

vtkXMLStructuredGridWriter.InitializeObjectBase¶

void InitializeObjectBase()

Type:	C++

vtkXMLStructuredGridWriter.Int32 = 32¶

vtkXMLStructuredGridWriter.Int64 = 64¶

vtkXMLStructuredGridWriter.InvokeEvent¶

int InvokeEvent(unsigned long event, void *callData) V.InvokeEvent(string, void) -> int C++: int InvokeEvent(const char *event, void *callData) V.InvokeEvent(int) -> int C++: int InvokeEvent(unsigned long event) V.InvokeEvent(string) -> int C++: int InvokeEvent(const char *event)

This method invokes an event and return whether the event was aborted or not. If the event was aborted, the return value is 1, otherwise it is 0.

Type:	C++

vtkXMLStructuredGridWriter.IsA¶

vtkTypeBool IsA(const char *type) override;

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Type:	C++

vtkXMLStructuredGridWriter.IsTypeOf¶

static vtkTypeBool IsTypeOf(const char *type)

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Type:	C++

vtkXMLStructuredGridWriter.LZ4 = 2¶

vtkXMLStructuredGridWriter.LittleEndian = 1¶

vtkXMLStructuredGridWriter.Modified¶

virtual void Modified()

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. The modification time is a unique monotonically increasing unsigned long integer.

Type:	C++

vtkXMLStructuredGridWriter.ModifyRequest¶

virtual int ModifyRequest(vtkInformation *request, int when)

This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. The default implementation is empty. Returns 1 on success, 0 on failure. When can be either vtkExecutive::BeforeForward or vtkExecutive::AfterForward.

Type:	C++

vtkXMLStructuredGridWriter.NONE = 0¶

vtkXMLStructuredGridWriter.NewInstance¶

vtkXMLStructuredGridWriter *NewInstance()

Type:	C++

vtkXMLStructuredGridWriter.ProcessRequest¶

V.ProcessRequest(vtkInformation, vtkCollection,: vtkInformationVector) -> int
C++: int ProcessRequest(vtkInformation *request,: vtkCollection *inInfo, vtkInformationVector *outInfo)

Version of ProcessRequest() that is wrapped. This converts the collection to an array and calls the other version.

vtkXMLStructuredGridWriter.PropagateUpdateExtent¶

virtual void PropagateUpdateExtent()

Propagate meta-data upstream.

Type:	C++

vtkXMLStructuredGridWriter.Register¶

virtual void Register(vtkObjectBase *o)

Increase the reference count by 1.

Type:	C++

vtkXMLStructuredGridWriter.ReleaseDataFlagOff¶

void ReleaseDataFlagOff()

Turn release data flag on or off for all output ports.

Type:	C++

vtkXMLStructuredGridWriter.ReleaseDataFlagOn¶

void ReleaseDataFlagOn()

Turn release data flag on or off for all output ports.

Type:	C++

vtkXMLStructuredGridWriter.RemoveAllInputConnections¶

virtual void RemoveAllInputConnections(int port)

Removes all input connections.

Type:	C++

vtkXMLStructuredGridWriter.RemoveAllInputs¶

void RemoveAllInputs()

Remove all the input data.

Type:	C++

vtkXMLStructuredGridWriter.RemoveAllObservers¶

void RemoveAllObservers()

Type:	C++

vtkXMLStructuredGridWriter.RemoveInputConnection¶

virtual void RemoveInputConnection(int port,: vtkAlgorithmOutput *input)

V.RemoveInputConnection(int, int) C++: virtual void RemoveInputConnection(int port, int idx)

Remove a connection from the given input port index. See SetInputConnection() for details on input connection. This method is the complement to AddInputConnection() in that it removes only the connection specified without affecting other connections. Typical usage is

filter2->RemoveInputConnection(0, filter1->GetOutputPort(0)).

Type:	C++

vtkXMLStructuredGridWriter.RemoveObserver¶

void RemoveObserver(vtkCommand *) V.RemoveObserver(int) C++: void RemoveObserver(unsigned long tag)

Allow people to add/remove/invoke observers (callbacks) to any VTK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and a vtkCommand to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. When events are invoked, the observers are called in the order they were added. If a priority value is specified, then the higher priority commands are called first. A command may set an abort flag to stop processing of the event. (See vtkCommand.h for more information.)

Type:	C++

vtkXMLStructuredGridWriter.RemoveObservers¶

void RemoveObservers(unsigned long event, vtkCommand *) V.RemoveObservers(string, vtkCommand) C++: void RemoveObservers(const char *event, vtkCommand *) V.RemoveObservers(int) C++: void RemoveObservers(unsigned long event) V.RemoveObservers(string) C++: void RemoveObservers(const char *event)

Allow people to add/remove/invoke observers (callbacks) to any VTK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and a vtkCommand to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. When events are invoked, the observers are called in the order they were added. If a priority value is specified, then the higher priority commands are called first. A command may set an abort flag to stop processing of the event. (See vtkCommand.h for more information.)

Type:	C++

vtkXMLStructuredGridWriter.SINGLE_PRECISION = 0¶

vtkXMLStructuredGridWriter.SafeDownCast¶

static vtkXMLStructuredGridWriter *SafeDownCast( vtkObjectBase *o)

Type:	C++

vtkXMLStructuredGridWriter.SetAbortExecute¶

virtual void SetAbortExecute(int _arg)

Set/Get the AbortExecute flag for the process object. Process objects may handle premature termination of execution in different ways.

Type:	C++

vtkXMLStructuredGridWriter.SetBlockSize¶

virtual void SetBlockSize(size_t blockSize)

Get/Set the block size used in compression. When reading, this controls the granularity of how much extra information must be read when only part of the data are requested. The value should be a multiple of the largest scalar data type.

Type:	C++

vtkXMLStructuredGridWriter.SetByteOrder¶

virtual void SetByteOrder(int _arg)

Get/Set the byte order of data written to the file. The default is the machine’s hardware byte order.

Type:	C++

vtkXMLStructuredGridWriter.SetByteOrderToBigEndian¶

void SetByteOrderToBigEndian()

Get/Set the byte order of data written to the file. The default is the machine’s hardware byte order.

Type:	C++

vtkXMLStructuredGridWriter.SetByteOrderToLittleEndian¶

void SetByteOrderToLittleEndian()

Get/Set the byte order of data written to the file. The default is the machine’s hardware byte order.

Type:	C++

vtkXMLStructuredGridWriter.SetCompressor¶

virtual void SetCompressor(vtkDataCompressor *)

Get/Set the compressor used to compress binary and appended data before writing to the file. Default is a vtkZLibDataCompressor.

Type:	C++

vtkXMLStructuredGridWriter.SetCompressorType¶

void SetCompressorType(int compressorType)

Convenience functions to set the compressor to certain known types.

Type:	C++

vtkXMLStructuredGridWriter.SetCompressorTypeToLZ4¶

void SetCompressorTypeToLZ4()

Convenience functions to set the compressor to certain known types.

Type:	C++

vtkXMLStructuredGridWriter.SetCompressorTypeToNone¶

void SetCompressorTypeToNone()

Convenience functions to set the compressor to certain known types.

Type:	C++

vtkXMLStructuredGridWriter.SetCompressorTypeToZLib¶

void SetCompressorTypeToZLib()

Convenience functions to set the compressor to certain known types.

Type:	C++

vtkXMLStructuredGridWriter.SetDataMode¶

virtual void SetDataMode(int _arg)

Get/Set the data mode used for the file’s data. The options are vtkXMLWriter::Ascii, vtkXMLWriter::Binary, and vtkXMLWriter::Appended.

Type:	C++

vtkXMLStructuredGridWriter.SetDataModeToAppended¶

void SetDataModeToAppended()

Get/Set the data mode used for the file’s data. The options are vtkXMLWriter::Ascii, vtkXMLWriter::Binary, and vtkXMLWriter::Appended.

Type:	C++

vtkXMLStructuredGridWriter.SetDataModeToAscii¶

void SetDataModeToAscii()

Get/Set the data mode used for the file’s data. The options are vtkXMLWriter::Ascii, vtkXMLWriter::Binary, and vtkXMLWriter::Appended.

Type:	C++

vtkXMLStructuredGridWriter.SetDataModeToBinary¶

void SetDataModeToBinary()

Get/Set the data mode used for the file’s data. The options are vtkXMLWriter::Ascii, vtkXMLWriter::Binary, and vtkXMLWriter::Appended.

Type:	C++

vtkXMLStructuredGridWriter.SetDebug¶

void SetDebug(bool debugFlag)

Set the value of the debug flag. A true value turns debugging on.

Type:	C++

vtkXMLStructuredGridWriter.SetDefaultExecutivePrototype¶

static void SetDefaultExecutivePrototype(vtkExecutive *proto)

If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance().

Type:	C++

vtkXMLStructuredGridWriter.SetEncodeAppendedData¶

virtual void SetEncodeAppendedData(int _arg)

Get/Set whether the appended data section is base64 encoded. If encoded, reading and writing will be slower, but the file will be fully valid XML and text-only. If not encoded, the XML specification will be violated, but reading and writing will be fast. The default is to do the encoding.

Type:	C++

vtkXMLStructuredGridWriter.SetExecutive¶

virtual void SetExecutive(vtkExecutive *executive)

Set this algorithm’s executive. This algorithm is removed from any executive to which it has previously been assigned and then assigned to the given executive.

Type:	C++

vtkXMLStructuredGridWriter.SetFileName¶

virtual void SetFileName(const char *_arg)

Get/Set the name of the output file.

Type:	C++

vtkXMLStructuredGridWriter.SetGhostLevel¶

virtual void SetGhostLevel(int _arg)

Get/Set the ghost level used to pad each piece.

Type:	C++

vtkXMLStructuredGridWriter.SetGlobalWarningDisplay¶

static void SetGlobalWarningDisplay(int val)

This is a global flag that controls whether any debug, warning or error messages are displayed.

Type:	C++

vtkXMLStructuredGridWriter.SetHeaderType¶

virtual void SetHeaderType(int)

Get/Set the binary data header word type. The default is UInt32. Set to UInt64 when storing arrays requiring 64-bit indexing.

Type:	C++

vtkXMLStructuredGridWriter.SetHeaderTypeToUInt32¶

void SetHeaderTypeToUInt32()

Get/Set the binary data header word type. The default is UInt32. Set to UInt64 when storing arrays requiring 64-bit indexing.

Type:	C++

vtkXMLStructuredGridWriter.SetHeaderTypeToUInt64¶

void SetHeaderTypeToUInt64()

Get/Set the binary data header word type. The default is UInt32. Set to UInt64 when storing arrays requiring 64-bit indexing.

Type:	C++

vtkXMLStructuredGridWriter.SetIdType¶

virtual void SetIdType(int)

Get/Set the size of the vtkIdType values stored in the file. The default is the real size of vtkIdType.

Type:	C++

vtkXMLStructuredGridWriter.SetIdTypeToInt32¶

void SetIdTypeToInt32()

Get/Set the size of the vtkIdType values stored in the file. The default is the real size of vtkIdType.

Type:	C++

vtkXMLStructuredGridWriter.SetIdTypeToInt64¶

void SetIdTypeToInt64()

Get/Set the size of the vtkIdType values stored in the file. The default is the real size of vtkIdType.

Type:	C++

vtkXMLStructuredGridWriter.SetInformation¶

virtual void SetInformation(vtkInformation *)

Set/Get the information object associated with this algorithm.

Type:	C++

vtkXMLStructuredGridWriter.SetInputArrayToProcess¶

virtual void SetInputArrayToProcess(int idx, int port,: int connection, int fieldAssociation, const char *name)

V.SetInputArrayToProcess(int, int, int, int, int) C++: virtual void SetInputArrayToProcess(int idx, int port,

int connection, int fieldAssociation, int fieldAttributeType)

V.SetInputArrayToProcess(int, vtkInformation) C++: virtual void SetInputArrayToProcess(int idx,

vtkInformation *info)

V.SetInputArrayToProcess(int, int, int, string, string) C++: virtual void SetInputArrayToProcess(int idx, int port,

int connection, const char *fieldAssociation, const char *attributeTypeorName)

Set the input data arrays that this algorithm will process. Specifically the idx array that this algorithm will process (starting from 0) is the array on port, connection with the specified association and name or attribute type (such as SCALARS). The fieldAssociation refers to which field in the data object the array is stored. See vtkDataObject::FieldAssociations for detail.

Type:	C++

vtkXMLStructuredGridWriter.SetInputConnection¶

virtual void SetInputConnection(int port,: vtkAlgorithmOutput *input)

V.SetInputConnection(vtkAlgorithmOutput) C++: virtual void SetInputConnection(vtkAlgorithmOutput *input)

Set the connection for the given input port index. Each input port of a filter has a specific purpose. A port may have zero or more connections and the required number is specified by each filter. Setting the connection with this method removes all other connections from the port. To add more than one connection use AddInputConnection().

The input for the connection is the output port of another
filter, which is obtained with GetOutputPort(). Typical usage is
filter2->SetInputConnection(0, filter1->GetOutputPort(0)).

Type:	C++

vtkXMLStructuredGridWriter.SetInputData¶

void SetInputData(vtkDataObject *) V.SetInputData(int, vtkDataObject) C++: void SetInputData(int, vtkDataObject *)

Assign a data object as input. Note that this method does not establish a pipeline connection. Use SetInputConnection() to setup a pipeline connection.

Type:	C++

vtkXMLStructuredGridWriter.SetInputDataObject¶

virtual void SetInputDataObject(int port,: vtkDataObject *data)

V.SetInputDataObject(vtkDataObject) C++: virtual void SetInputDataObject(vtkDataObject *data)

Sets the data-object as an input on the given port index. Setting the input with this method removes all other connections from the port. Internally, this method creates a vtkTrivialProducer instance and sets that as the input-connection for the given port. It is safe to call this method repeatedly with the same input data object. The MTime of the vtkAlgorithm will not change unless the data object changed.

Type:	C++

vtkXMLStructuredGridWriter.SetNumberOfPieces¶

virtual void SetNumberOfPieces(int _arg)

Get/Set the number of pieces used to stream the image through the pipeline while writing to the file.

Type:	C++

vtkXMLStructuredGridWriter.SetNumberOfTimeSteps¶

virtual void SetNumberOfTimeSteps(int _arg)

Set the number of time steps

Type:	C++

vtkXMLStructuredGridWriter.SetProgress¶

virtual void SetProgress(double _arg)

Set/Get the execution progress of a process object.

Type:	C++

vtkXMLStructuredGridWriter.SetProgressObserver¶

void SetProgressObserver(vtkProgressObserver *)

If an ProgressObserver is set, the algorithm will report progress through it rather than directly. This means that it will call UpdateProgress() on the ProgressObserver rather than itself report it and set progress. This is most useful in situations where multiple threads are executing an algorithm at the same time and want to handle progress locally.

Type:	C++

vtkXMLStructuredGridWriter.SetProgressText¶

void SetProgressText(const char *ptext)

Set the current text message associated with the progress state. This may be used by a calling process/GUI. Note: Because SetProgressText() is called from inside RequestData() it does not modify the algorithm object. Algorithms are not allowed to modify themselves from inside RequestData().

Type:	C++

vtkXMLStructuredGridWriter.SetReferenceCount¶

void SetReferenceCount(int)

Sets the reference count. (This is very dangerous, use with care.)

Type:	C++

vtkXMLStructuredGridWriter.SetReleaseDataFlag¶

virtual void SetReleaseDataFlag(int)

Turn release data flag on or off for all output ports.

Type:	C++

vtkXMLStructuredGridWriter.SetWriteExtent¶

void SetWriteExtent(int, int, int, int, int, int) V.SetWriteExtent((int, int, int, int, int, int)) C++: void SetWriteExtent(int a[6])

Type:	C++

vtkXMLStructuredGridWriter.SetWritePiece¶

virtual void SetWritePiece(int _arg)

Get/Set the piece to write to the file. If this is negative, all pieces will be written.

Type:	C++

vtkXMLStructuredGridWriter.SetWriteToOutputString¶

virtual void SetWriteToOutputString(int _arg)

Enable writing to an OutputString instead of the default, a file.

Type:	C++

vtkXMLStructuredGridWriter.Start¶

void Start()

API to interface an outside the VTK pipeline control

Type:	C++

vtkXMLStructuredGridWriter.Stop¶

void Stop()

API to interface an outside the VTK pipeline control

Type:	C++

vtkXMLStructuredGridWriter.UInt32 = 32¶

vtkXMLStructuredGridWriter.UInt64 = 64¶

vtkXMLStructuredGridWriter.UnRegister¶

virtual void UnRegister(vtkObjectBase *o)

Decrease the reference count (release by another object). This has the same effect as invoking Delete() (i.e., it reduces the reference count by 1).

Type:	C++

vtkXMLStructuredGridWriter.Update¶

virtual void Update(int port) V.Update() C++: virtual void Update() V.Update(int, vtkInformationVector) -> int C++: virtual int Update(int port, vtkInformationVector *requests) V.Update(vtkInformation) -> int C++: virtual int Update(vtkInformation *requests)

Bring this algorithm’s outputs up-to-date.

Type:	C++

vtkXMLStructuredGridWriter.UpdateDataObject¶

virtual void UpdateDataObject()

Create output object(s).

Type:	C++

vtkXMLStructuredGridWriter.UpdateExtent¶

virtual int UpdateExtent(const int extents[6])

Convenience method to update an algorithm after passing requests to its first output port. Supports extent request.

Type:	C++

vtkXMLStructuredGridWriter.UpdateExtentIsEmpty¶

int UpdateExtentIsEmpty(vtkInformation *pinfo,: vtkDataObject *output)

V.UpdateExtentIsEmpty(vtkInformation, int) -> int C++: int UpdateExtentIsEmpty(vtkInformation *pinfo,

int extentType)

This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,…) or the UpdateNumberOfPieces is 0. The source uses this call to determine whether to call Execute.

Type:	C++

vtkXMLStructuredGridWriter.UpdateInformation¶

virtual void UpdateInformation()

Bring the algorithm’s information up-to-date.

Type:	C++

vtkXMLStructuredGridWriter.UpdatePiece¶

-> int C++: virtual int UpdatePiece(int piece, int numPieces,

int ghostLevels, const int extents[6]=nullptr)

Convenience method to update an algorithm after passing requests to its first output port. See documentation for Update(int port, vtkInformationVector* requests) for details. Supports piece and extent (optional) requests.

vtkXMLStructuredGridWriter.UpdateProgress¶

void UpdateProgress(double amount)

Update the progress of the process object. If a ProgressMethod exists, executes it. Then set the Progress ivar to amount. The parameter amount should range between (0,1).

Type:	C++

vtkXMLStructuredGridWriter.UpdateTimeStep¶

V.UpdateTimeStep(float, int, int, int, (int, int, int, int, int,: int)) -> int
C++: virtual int UpdateTimeStep(double time, int piece=-1,: int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)

Convenience method to update an algorithm after passing requests to its first output port. See documentation for Update(int port, vtkInformationVector* requests) for details. Supports time, piece (optional) and extent (optional) requests.

vtkXMLStructuredGridWriter.UpdateWholeExtent¶

virtual void UpdateWholeExtent()

Bring this algorithm’s outputs up-to-date.

Type:	C++

vtkXMLStructuredGridWriter.Write¶

int Write()

Invoke the writer. Returns 1 for success, 0 for failure.

Type:	C++

vtkXMLStructuredGridWriter.WriteNextTime¶

void WriteNextTime(double time)

API to interface an outside the VTK pipeline control

Type:	C++

vtkXMLStructuredGridWriter.WriteToOutputStringOff¶

virtual void WriteToOutputStringOff()

Enable writing to an OutputString instead of the default, a file.

Type:	C++

vtkXMLStructuredGridWriter.WriteToOutputStringOn¶

virtual void WriteToOutputStringOn()

Enable writing to an OutputString instead of the default, a file.

Type:	C++

vtkXMLStructuredGridWriter.ZLIB = 1¶

discretize.mixins.vtkModule.vtkXMLStructuredGridWriter¶

Attributes¶

Methods¶