tomodrgn.dataset.load_sta_dataset#
- load_sta_dataset(ptcls_star: TiltSeriesStarfile | TomoParticlesStarfile | None = None, config: str | dict[str, dict] | None = None, **kwargs) TiltSeriesMRCData | TomoParticlesMRCData[source]#
Loads a tomodrgn particles dataset class (either
TiltSeriesMRCDataorTomoParticlesMRCData) given an instantiated star file handler class. Loads particle image data, pose parameters, CTF parameters, dose and tilt weighting parameters, etc. This is the preferred way of creating a tomodrgn dataset class instance.- Parameters:
ptcls_star – pre-existing starfile object used to obtain file paths and metadata in creating the returned dataset object.
config – path to config.pkl or preloaded config.pkl dictionary as generated by tomodrgn. Allows loading a pre-existing dataset config with no further parameters specified. Otherwise, all parameters specified will be passed to the dataset’s
__init__method.
- Returns:
The created dataset object (either
TiltSeriesMRCDataorTomoParticlesMRCData)