tomodrgn.commands.downsample.write_downsampled_starfile#

write_downsampled_starfile(input_starfile: str, boxsize_old: int, boxsize_new: int, out_mrcs: str | list[str], chunk_size: int | None = None, source_software: Literal['auto', 'warp', 'cryosrpnt', 'nextpyp', 'cistem', 'warptools', 'relion'] = 'auto') → None[source]#

Write a STAR file describing a downsampled particle stack (optionally chunked into multiple .mrcs files) to disk.

Parameters:

• input_starfile – path to the star file used to reference original (non-downsampled) images

• boxsize_old – the original box size (units: px)

• boxsize_new – the new box size after Fourier cropping (units: px)

• out_mrcs – path to the downsampled mrcs file(s), referencing images in the same order as the original star file

• chunk_size – number of images chunked together in separate .mrcs files written to disk, if used. None means no chunking was performed.

• source_software – type of source software used to create the star file, used to indicate the appropriate star file handling class to instantiate. Default of ‘auto’ tries to infer the appropriate star file handling class based on whether star_path is an optimisation set star file.

Returns:

None