Writing

nmrPype.nmrio.write.write(filename, dic, data, overwrite=False)

Write a NMRPipe file to disk.

Parameters:

  • filename (str) – Filename of NMRPipe to write to. See Notes.

  • dic (dict) – Dictionary of NMRPipe parameters.

  • data (array_like) – Array of NMR data.

  • overwrite (bool, optional.) – Set True to overwrite files, False will raise a Warning if file exists.

Notes

For 3D data if filename has no ‘%’ formatter then the data is written as a 3D NMRPipe data stream. When the ‘%’ formatter is provided the data is written out as a standard NMRPipe 3D multi-file 3D.

For 4D data, filename can have one, two or no ‘%’ formatters resulting in a single index file (test%03d.ft), two index file(test%02d%03d.ft), or one file data stream (test.ft4).

dic[“FDPIPEFLAG”] is not changed or checked when writing, please check that this value is 0.0 for standard non-data stream files, and 1.0 for data stream files or an file may be written with an incorrect header.

Set overwrite to True to overwrite files that exist.

See also

write_lowmem

Write NMRPipe files using minimal amounts of memory.

read

Read NMRPipe files.

nmrPype.nmrio.write.write_3D(filemask, dic, data, overwrite=False)

Write a standard multi-file 3D NMRPipe file

See write() for documentation.

nmrPype.nmrio.write.write_4D(filemask, dic, data, overwrite=False)

Write a one or two index 4D NMRPipe file.

See write() for documentation.

nmrPype.nmrio.write.write_lowmem(filename, dic, data, overwrite=False)

Write a NMRPipe file to disk using minimal memory (trace by trace).

Parameters:

  • filename (str) – Filename of NMRPipe to write to. See write() for details.

  • dic (dict) – Dictionary of NMRPipe parameters.

  • data (array_like) – Array of NMR data.

  • overwrite (bool, optional.) – Set True to overwrite files, False will raise a Warning if file exists.

See also

write

Write a NMRPipe file to disk.

read_lowmem

Read a NMRPipe file using minimal memory.

nmrPype.nmrio.write.write_lowmem_2D(filename, dic, data, overwrite=False)

Write a 2D NMRPipe file using minimal memory (trace by trace)

See write_lowmem() for documentation.

nmrPype.nmrio.write.write_lowmem_3D(filename, dic, data, overwrite=False)

Write a standard multi-file 3D NMRPipe file using minimal memory.

See write_lowmem() for documentation.

Notes

MIN/MAX parameters are not updated in the NMRPipe headers.

nmrPype.nmrio.write.write_lowmem_3Ds(filename, dic, data, overwrite=False)

Write 3D NMRPipe data stream file using minimal memory (trace by trace)

See write_lowmem() for documentation.

nmrPype.nmrio.write.write_lowmem_4D(filename, dic, data, overwrite=False)

Write a multi-file (single or double index) 4D NMRPipe file using minimal memory.

See write_lowmem() for documentation.

Notes

MIN/MAX parameters are not updated in the NMRPipe headers.

nmrPype.nmrio.write.write_lowmem_4Ds(filename, dic, data, overwrite=False)

Write 4D NMRPipe data stream file using minimal memory (trace by trace)

See write_lowmem() for documentation.

nmrPype.nmrio.write.write_single(filename, dic, data, overwrite=False)

Write data to a single NMRPipe file from memory.

Write 1D and 2D files completely as well as NMRPipe data streams. 2D planes of 3D and 4D files should be written with this function.

See write() for documentation.