Difference between revisions of "Catalogue"

From Dynamo
Jump to navigation Jump to search
Line 12: Line 12:
 
==Getting started==
 
==Getting started==
 
The best way to get familiar with the logic of the ''Dynamo'' catalogues is by [[dynamo_catalogue_tutorial|generating a test catalogue]] for a set of automatically created toy tomograms.
 
The best way to get familiar with the logic of the ''Dynamo'' catalogues is by [[dynamo_catalogue_tutorial|generating a test catalogue]] for a set of automatically created toy tomograms.
 +
 +
== Basic functionalities ==
 +
 +
In the command line, most functionalities are accessible trough the <tt>dcm</tt> command. Type <tt>help dcm</tt> for an exhaustive list.
 +
 +
=== Creating a catalogue ===
 +
 +
In the command line, you can just type:
 +
 +
<tt>dcm -create myCatalogue</tt>
 +
 +
It will create a new catalogue in the current folder. It will appear as a folder called <tt>myCatalogue</tt> and a file called <tt>myCatalogue</tt>.
 +
 +
If you apply these functionalities on a catalogue currently in scope in the <tt>dcm gui</tt>, the GUI will '''not''' update automatically. You need to press explicitly on the [list volumes] button. 
 +
 +
=== Entering a set of tomograms ===
 +
 +
==== Duting creation ====
 +
You can enter directly a set of tomograms in the moment of creation of the catalogue through the flag <tt>fromvll</tt>
 +
 +
<tt>dcm -create myCatalogue -fromvll myList.vll</tt>
 +
 +
Here <tt>myList.vll</tt> is a volume list. This is just a text file; the syntax can be rather complex, but in its simplest form it can be just a file with a tomogram file name at each line.
 +
 +
==== Into a existing catalogue===
 +
In this case, the flag is <tt>addvll</tt>
 +
<tt>dcm -c myCatalogue -addvll myList.vll</tt>
 +
 +
 +
=== Entering a single tomogram ===
 +
You can use the <tt>addTomogram</tt> (<tt>at</tt>) flag
 +
<tt>dcm -c myCatalogue -at perro.em</tt>

Revision as of 13:01, 19 April 2017


The catalogue is a simple way to keep track of the work that has been done on groups of tomograms. This work normally aims at the definition of positions (and possibly orientations) inside each tomogram, so that subvolumes can be defined and cropped, to produce an unique data folder with its corresponding table that can be feed into a project for alignment or classification.

If you have already a set of subtomograms, you have already all the initial orientations you could reasonably extract from the tomograms and you don't want to extract the tomograms again, you probably don't need to define a catalogue. You already have all you need to start designing alignment projects.

Keeping a catalogue is not necessary for cropping particles out of your tomograms. The tools associated with the catalogue can easily be used independently at any stage. We however encourage you to organize your tomograms in a catalogue from the very beginning, as this induces a very smooth workflow and eliminates lengthy administrative overheads that are prone to happen on a later stage.

The main tool to work with catalogues is the dcm GUI, that also provides command line functionality to create, edit an extract information from catalogues. Help on command syntax: dcm

Getting started

The best way to get familiar with the logic of the Dynamo catalogues is by generating a test catalogue for a set of automatically created toy tomograms.

Basic functionalities

In the command line, most functionalities are accessible trough the dcm command. Type help dcm for an exhaustive list.

Creating a catalogue

In the command line, you can just type:

dcm -create myCatalogue

It will create a new catalogue in the current folder. It will appear as a folder called myCatalogue and a file called myCatalogue.

If you apply these functionalities on a catalogue currently in scope in the dcm gui, the GUI will not update automatically. You need to press explicitly on the [list volumes] button.

Entering a set of tomograms

Duting creation

You can enter directly a set of tomograms in the moment of creation of the catalogue through the flag fromvll

dcm -create myCatalogue -fromvll myList.vll

Here myList.vll is a volume list. This is just a text file; the syntax can be rather complex, but in its simplest form it can be just a file with a tomogram file name at each line.

= Into a existing catalogue

In this case, the flag is addvll dcm -c myCatalogue -addvll myList.vll


Entering a single tomogram

You can use the addTomogram (at) flag dcm -c myCatalogue -at perro.em