<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_rwmg_r_e_l_i_o_n_8h">
<title>/Users/bernard/b20/bsoft/include/rwmgRELION.h File Reference</title>
<indexterm><primary>/Users/bernard/b20/bsoft/include/rwmgRELION.h</primary></indexterm>
<para>

<para>Header file for reading and writing micrograph parameters from and to the RELION STAR format. </para>
 
</para>
<programlisting>#include &quot;mg_processing.h&quot;
#include &quot;rwstar.h&quot;
</programlisting><simplesect>
    <title>Functions    </title>
        <itemizedlist>
            <listitem><para>int <link linkend="_rwmg_r_e_l_i_o_n_8h_1aafbd19cba681ee32ce5c6a79403d25bd">read_project_relion</link> (<link linkend="_class_bstring">Bstring</link> &amp;filename, <link linkend="_struct_bproject">Bproject</link> *<link linkend="_tcltk__bmodel_8cpp_1aea438e09dfc03683a0f49a05e9a69cac">project</link>)</para>

<para>Reading micrograph parameters from a Relion file. </para>
</listitem>
            <listitem><para>int <link linkend="_rwmg_r_e_l_i_o_n_8h_1a82157ccbf9cfb11cd8966aad1fae8a0c">write_project_relion</link> (<link linkend="_class_bstring">Bstring</link> &amp;filename, <link linkend="_struct_bproject">Bproject</link> *<link linkend="_tcltk__bmodel_8cpp_1aea438e09dfc03683a0f49a05e9a69cac">project</link>, int mg_select, int rec_select)</para>

<para>Writing micrograph parameters to a Relion file. </para>
</listitem>
            <listitem><para>int <link linkend="_rwmg_r_e_l_i_o_n_8h_1aff9616ad1f3a85594ee336a8e6a128e3">project_split_particles</link> (<link linkend="_struct_bproject">Bproject</link> *<link linkend="_tcltk__bmodel_8cpp_1aea438e09dfc03683a0f49a05e9a69cac">project</link>, <link linkend="_class_bstring">Bstring</link> partfile, <link linkend="_class_bstring">Bstring</link> path, <link linkend="_class_bstring">Bstring</link> partext)</para>

<para>Modifies some micrograph parameters. </para>
</listitem>
        </itemizedlist>
</simplesect>
<section>
<title>Detailed Description</title>

<para>Header file for reading and writing micrograph parameters from and to the RELION STAR format. </para>

<para><formalpara><title>Author: </title>

<para>Bernard Heymann </para>
</formalpara>
<formalpara><title>Date: </title>

<para>Created: 20061101 </para>

<para>Modified: 20180525 </para>
</formalpara>
</para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_rwmg_r_e_l_i_o_n_8h_1aff9616ad1f3a85594ee336a8e6a128e3"/>    <section>
    <title>project_split_particles()</title>
<indexterm><primary>project_split_particles</primary><secondary>rwmgRELION.h</secondary></indexterm>
<indexterm><primary>rwmgRELION.h</primary><secondary>project_split_particles</secondary></indexterm>
<para><computeroutput>int project_split_particles (<link linkend="_struct_bproject">Bproject</link> * project, <link linkend="_class_bstring">Bstring</link> partfile, <link linkend="_class_bstring">Bstring</link> path, <link linkend="_class_bstring">Bstring</link> partext)</computeroutput></para><para>

<para>Modifies some micrograph parameters. </para>
</para>

<para>
                <formalpara>
                    <title>
Parameters                    </title>
                    <para>
                    <table frame="all">
                        <tgroup cols="2" align="left" colsep="1" rowsep="1">
                        <colspec colwidth="1*"/>
                        <colspec colwidth="4*"/>
                        <tbody>
                            <row>
                                <entry>*project</entry>
                                <entry>
<para>project structure. </para>
</entry>
                            </row>
                            <row>
                                <entry>partfile</entry>
                                <entry>
<para>Relion stack of particles file. </para>
</entry>
                            </row>
                            <row>
                                <entry>path</entry>
                                <entry>
<para>path to write new particle files. </para>
</entry>
                            </row>
                            <row>
                                <entry>partext</entry>
                                <entry>
<para>extension to set the new particle image format. </para>
</entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                <formalpara><title>Returns: </title>

<para>int error code (&lt;0 means failure). </para>
</formalpara>
</para>
<para>
Definition at line 303 of file rwmgRELION.cpp.</para>
    </section><anchor xml:id="_rwmg_r_e_l_i_o_n_8h_1aafbd19cba681ee32ce5c6a79403d25bd"/>    <section>
    <title>read_project_relion()</title>
<indexterm><primary>read_project_relion</primary><secondary>rwmgRELION.h</secondary></indexterm>
<indexterm><primary>rwmgRELION.h</primary><secondary>read_project_relion</secondary></indexterm>
<para><computeroutput>int read_project_relion (<link linkend="_class_bstring">Bstring</link> &amp; filename, <link linkend="_struct_bproject">Bproject</link> * project)</computeroutput></para><para>

<para>Reading micrograph parameters from a Relion file. </para>
</para>

<para>
                <formalpara>
                    <title>
Parameters                    </title>
                    <para>
                    <table frame="all">
                        <tgroup cols="2" align="left" colsep="1" rowsep="1">
                        <colspec colwidth="1*"/>
                        <colspec colwidth="4*"/>
                        <tbody>
                            <row>
                                <entry>&amp;filename</entry>
                                <entry>
<para>file name (or comma-delimited list). </para>
</entry>
                            </row>
                            <row>
                                <entry>*project</entry>
                                <entry>
<para>initialized project structure. </para>
</entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                <formalpara><title>Returns: </title>

<para>int error code (&lt;0 means failure). </para>
</formalpara>
</para>
<para>
Definition at line 249 of file rwmgRELION.cpp.</para>
    </section><anchor xml:id="_rwmg_r_e_l_i_o_n_8h_1a82157ccbf9cfb11cd8966aad1fae8a0c"/>    <section>
    <title>write_project_relion()</title>
<indexterm><primary>write_project_relion</primary><secondary>rwmgRELION.h</secondary></indexterm>
<indexterm><primary>rwmgRELION.h</primary><secondary>write_project_relion</secondary></indexterm>
<para><computeroutput>int write_project_relion (<link linkend="_class_bstring">Bstring</link> &amp; filename, <link linkend="_struct_bproject">Bproject</link> * project, int mg_select, int rec_select)</computeroutput></para><para>

<para>Writing micrograph parameters to a Relion file. </para>
</para>

<para>
                <formalpara>
                    <title>
Parameters                    </title>
                    <para>
                    <table frame="all">
                        <tgroup cols="2" align="left" colsep="1" rowsep="1">
                        <colspec colwidth="1*"/>
                        <colspec colwidth="4*"/>
                        <tbody>
                            <row>
                                <entry>*filename</entry>
                                <entry>
<para>file name. </para>
</entry>
                            </row>
                            <row>
                                <entry>*project</entry>
                                <entry>
<para>project structure. </para>
</entry>
                            </row>
                            <row>
                                <entry>mg_select</entry>
                                <entry>
<para>flag to select micrograph. </para>
</entry>
                            </row>
                            <row>
                                <entry>rec_select</entry>
                                <entry>
<para>flag to select reconstruction. </para>
</entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                <formalpara><title>Returns: </title>

<para>int error code (&lt;0 means failure). </para>
</formalpara>
</para>
<para>
Definition at line 277 of file rwmgRELION.cpp.</para>
</section>
</section>
</section>
