yt.raven.PlotCollection.save

PlotCollection.save(basename=None, format='png', override=False, force_save=False)

Save out all the plots hanging off this plot collection, using generated names.

This function will create names for every plot that belongs to the PlotCollection and save them out. The names will, by default, be prefixed with the name of the affiliate parameter file, and the file names should indicate clearly what each plot represents.

Parameters :

basename : string, optional

The prefix for all of the plot filenames.

format : string, optional

The plot file format. Can be ‘png’, ‘pdf’, ‘eps’, ‘jpg’, or anything else that matplotlib understands.

override : boolean

If this is true, then no generated filenames will be appended to the base name. You probably don’t want this.

force_save : boolean

In parallel, only the root task (proc 0) saves an image, unless this is set to True.

Returns :

items : string

This function returns a list of the filenames created.

Examples

>>> fns = pc.save()
>>> for fn in fns: print "Saved", fn

Previous topic

yt.raven.PlotCollection.autoscale

Next topic

yt.raven.PlotCollection.save_book

This Page