Frame module

Classes which hold frames.

class sdanalysis.frame.Frame[source]

Bases: abc.ABC

abstract property box
Return type

ndarray

abstract property dimensions
Return type

int

freud_box()[source]
Return type

Box

abstract property image
Return type

Optional[ndarray]

abstract property orientation
Return type

ndarray

abstract property position
Return type

ndarray

abstract property timestep
Return type

int

abstract property x_position
Return type

ndarray

abstract property y_position
Return type

ndarray

abstract property z_position
Return type

ndarray

class sdanalysis.frame.HoomdFrame(frame)[source]

Bases: sdanalysis.frame.Frame

property box
Return type

ndarray

property dimensions
Return type

int

property image
Return type

Optional[ndarray]

property num_mols
property orientation
Return type

ndarray

property position
Return type

ndarray

property timestep
Return type

int

property x_position
Return type

ndarray

property y_position
Return type

ndarray

property z_position
Return type

ndarray

class sdanalysis.frame.LammpsFrame(frame)[source]

Bases: sdanalysis.frame.Frame

property box
Return type

ndarray

property dimensions
Return type

int

property image
Return type

Optional[ndarray]

property orientation
Return type

ndarray

property position
Return type

ndarray

property timestep
Return type

int

property x_position
Return type

ndarray

property y_position
Return type

ndarray

property z_position
Return type

ndarray