mstk.trajectory.Dcd

class mstk.trajectory.Dcd(file, mode='r')

Read and write step, cell and positions from/to DCD file.

Currently mstk use chemfiles to support DCD file.

Methods

__init__(file[, mode])

close()

Close the handler.

get_handler_for_file(file)

Get the appropriate handler class for a trajectory file.

get_info()

Get the number of atoms and frames in the trajectory.

read_frame(i_frame, frame)

Read a single frame.

register_format(extension, Handler)

Register a handler class for a trajectory format based on the extension name

write_frame(frame[, subset])

Write a frame into the opened DCD file

close()

Close the handler.

get_info()

Get the number of atoms and frames in the trajectory.

Also record the offset of lines and frames, so that we can read arbitrary frame later. It assumes all frames have the same number of atoms.

Returns:

  • n_atom (int)

  • n_frame (int)

read_frame(i_frame, frame)

Read a single frame.

Parameters:
  • i_frame (int) – The index of the frame in the trajectory

  • frame (Frame) – The information read from the trajectory will be written into this Frame

write_frame(frame, subset=None, **kwargs)

Write a frame into the opened DCD file

Parameters:
  • frame (Frame) –

  • subset (list of int, optional) –

  • kwargs (dict) – Ignored