<?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="_rwmodel__bild_8h">
<title>/Users/bernard/b20/bsoft/include/rwmodel_bild.h File Reference</title>
<indexterm><primary>/Users/bernard/b20/bsoft/include/rwmodel_bild.h</primary></indexterm>
<para>

<para>Header file for reading and writing Chimera BILD files. </para>
 
</para>
<programlisting>#include &quot;rwmodel.h&quot;
</programlisting><simplesect>
    <title>Functions    </title>
        <itemizedlist>
            <listitem><para><link linkend="_struct_bmodel">Bmodel</link> * <link linkend="_rwmodel__bild_8h_1a4860aaca357985b9d9efce7a48ad70ee">read_model_bild</link> (<link linkend="_class_bstring">Bstring</link> *file_list)</para>

<para>Reads Chimera BILD model parameters. </para>
</listitem>
            <listitem><para>int <link linkend="_rwmodel__bild_8h_1aee5f32ef4b7ede2128e09c96be9aed97">write_model_bild</link> (<link linkend="_class_bstring">Bstring</link> &amp;filename, <link linkend="_struct_bmodel">Bmodel</link> *<link linkend="_tcltk__bmodel_8cpp_1a828359eaa8de833b547ac96934f43841">model</link>)</para>

<para>Writes Chimera BILD model parameters. </para>
</listitem>
            <listitem><para>int <link linkend="_rwmodel__bild_8h_1ae6bab230a8bd45a44739abefc70e9ef3">model_to_bild_orientations</link> (<link linkend="_class_bstring">Bstring</link> &amp;filename, <link linkend="_struct_bmodel">Bmodel</link> *<link linkend="_tcltk__bmodel_8cpp_1a828359eaa8de833b547ac96934f43841">model</link>, int vec_type, int color_type)</para>

<para>Converts a model into a representation with views. </para>
</listitem>
            <listitem><para>int <link linkend="_rwmodel__bild_8h_1abdb2fe00ab1a841720f4eb92aee04ff2">model_to_bild_view_sphere</link> (<link linkend="_class_bstring">Bstring</link> &amp;filename, <link linkend="_struct_bmodel">Bmodel</link> *<link linkend="_tcltk__bmodel_8cpp_1a828359eaa8de833b547ac96934f43841">model</link>, int color_type)</para>

<para>Converts a model into a representation with views. </para>
</listitem>
            <listitem><para>int <link linkend="_rwmodel__bild_8h_1af6738624ffd062eb05a425684928a8d1">model_to_bild_view_polygons</link> (<link linkend="_class_bstring">Bstring</link> &amp;filename, <link linkend="_struct_bmodel">Bmodel</link> *<link linkend="_tcltk__bmodel_8cpp_1a828359eaa8de833b547ac96934f43841">model</link>, int order, int color_type)</para>

<para>Converts a model into a representation with view polygons. </para>
</listitem>
            <listitem><para>int <link linkend="_rwmodel__bild_8h_1a35269022e5a7c8023d82b72a632f39c5">model_to_bild_polygons</link> (<link linkend="_class_bstring">Bstring</link> &amp;filename, <link linkend="_struct_bmodel">Bmodel</link> *<link linkend="_tcltk__bmodel_8cpp_1a828359eaa8de833b547ac96934f43841">model</link>, int color_type)</para>

<para>Converts a model into a bild polygon representation. </para>
</listitem>
            <listitem><para>int <link linkend="_rwmodel__bild_8h_1a0b6c27c31979b64a961b23a34b31789f">model_to_bild_neighbor_planes</link> (<link linkend="_class_bstring">Bstring</link> &amp;filename, <link linkend="_struct_bmodel">Bmodel</link> *<link linkend="_tcltk__bmodel_8cpp_1a828359eaa8de833b547ac96934f43841">model</link>, int color_type)</para>

<para>Converts a model into a bild neighbor plane representation. </para>
</listitem>
        </itemizedlist>
</simplesect>
<section>
<title>Detailed Description</title>

<para>Header file for reading and writing Chimera BILD files. </para>

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

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

<para>Created: 20140706 </para>

<para>Modified: 20160616 </para>
</formalpara>
</para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_rwmodel__bild_8h_1a0b6c27c31979b64a961b23a34b31789f"/>    <section>
    <title>model_to_bild_neighbor_planes()</title>
<indexterm><primary>model_to_bild_neighbor_planes</primary><secondary>rwmodel_bild.h</secondary></indexterm>
<indexterm><primary>rwmodel_bild.h</primary><secondary>model_to_bild_neighbor_planes</secondary></indexterm>
<para><computeroutput>int model_to_bild_neighbor_planes (<link linkend="_class_bstring">Bstring</link> &amp; filename, <link linkend="_struct_bmodel">Bmodel</link> * model, int color_type)</computeroutput></para><para>

<para>Converts a model into a bild neighbor plane representation. </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>bild format file name. </para>
</entry>
                            </row>
                            <row>
                                <entry>*model</entry>
                                <entry>
<para>model structure. </para>
</entry>
                            </row>
                            <row>
                                <entry>color_type</entry>
                                <entry>
<para>flag to color planes. </para>
</entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                <formalpara><title>Returns: </title>

<para>int 0, &lt;0 on error. <literallayout><computeroutput>Color scheme types:
    1   spectrum/rainbow.
    2   fom.
</computeroutput></literallayout> </para>
</formalpara>
</para>
<para>
Definition at line 593 of file rwmodel_bild.cpp.</para>
    </section><anchor xml:id="_rwmodel__bild_8h_1ae6bab230a8bd45a44739abefc70e9ef3"/>    <section>
    <title>model_to_bild_orientations()</title>
<indexterm><primary>model_to_bild_orientations</primary><secondary>rwmodel_bild.h</secondary></indexterm>
<indexterm><primary>rwmodel_bild.h</primary><secondary>model_to_bild_orientations</secondary></indexterm>
<para><computeroutput>int model_to_bild_orientations (<link linkend="_class_bstring">Bstring</link> &amp; filename, <link linkend="_struct_bmodel">Bmodel</link> * model, int vec_type, int color_type)</computeroutput></para><para>

<para>Converts a model into a representation with views. </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>bild format file name. </para>
</entry>
                            </row>
                            <row>
                                <entry>*model</entry>
                                <entry>
<para>model structure. </para>
</entry>
                            </row>
                            <row>
                                <entry>vec_type</entry>
                                <entry>
<para>0=views, 1=vectors, 2=velocity vectors. </para>
</entry>
                            </row>
                            <row>
                                <entry>color_type</entry>
                                <entry>
<para>flag to color components. </para>
</entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                <formalpara><title>Returns: </title>

<para>int 0, &lt;0 on error. <literallayout><computeroutput>A sphere is drawn for every component with a cylinder indicating its view.
</computeroutput></literallayout> </para>
</formalpara>
</para>
<para>
Definition at line 275 of file rwmodel_bild.cpp.</para>
    </section><anchor xml:id="_rwmodel__bild_8h_1a35269022e5a7c8023d82b72a632f39c5"/>    <section>
    <title>model_to_bild_polygons()</title>
<indexterm><primary>model_to_bild_polygons</primary><secondary>rwmodel_bild.h</secondary></indexterm>
<indexterm><primary>rwmodel_bild.h</primary><secondary>model_to_bild_polygons</secondary></indexterm>
<para><computeroutput>int model_to_bild_polygons (<link linkend="_class_bstring">Bstring</link> &amp; filename, <link linkend="_struct_bmodel">Bmodel</link> * model, int color_type)</computeroutput></para><para>

<para>Converts a model into a bild polygon representation. </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>bild format file name. </para>
</entry>
                            </row>
                            <row>
                                <entry>*model</entry>
                                <entry>
<para>model structure. </para>
</entry>
                            </row>
                            <row>
                                <entry>color_type</entry>
                                <entry>
<para>flag to color polygons. </para>
</entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                <formalpara><title>Returns: </title>

<para>int 0, &lt;0 on error. <literallayout><computeroutput>Color scheme types:
    1   spectrum/rainbow.
    2   fom.
</computeroutput></literallayout> </para>
</formalpara>
</para>
<para>
Definition at line 523 of file rwmodel_bild.cpp.</para>
    </section><anchor xml:id="_rwmodel__bild_8h_1af6738624ffd062eb05a425684928a8d1"/>    <section>
    <title>model_to_bild_view_polygons()</title>
<indexterm><primary>model_to_bild_view_polygons</primary><secondary>rwmodel_bild.h</secondary></indexterm>
<indexterm><primary>rwmodel_bild.h</primary><secondary>model_to_bild_view_polygons</secondary></indexterm>
<para><computeroutput>int model_to_bild_view_polygons (<link linkend="_class_bstring">Bstring</link> &amp; filename, <link linkend="_struct_bmodel">Bmodel</link> * model, int order, int color_type)</computeroutput></para><para>

<para>Converts a model into a representation with view polygons. </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>bild format file name. </para>
</entry>
                            </row>
                            <row>
                                <entry>*model</entry>
                                <entry>
<para>model structure. </para>
</entry>
                            </row>
                            <row>
                                <entry>order</entry>
                                <entry>
<para>polygon order. </para>
</entry>
                            </row>
                            <row>
                                <entry>color_type</entry>
                                <entry>
<para>flag to color components. </para>
</entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                <formalpara><title>Returns: </title>

<para>int 0, &lt;0 on error. <literallayout><computeroutput>A sphere is drawn for every component with a cylinder indicating its view.
</computeroutput></literallayout> </para>
</formalpara>
</para>
<para>
Definition at line 444 of file rwmodel_bild.cpp.</para>
    </section><anchor xml:id="_rwmodel__bild_8h_1abdb2fe00ab1a841720f4eb92aee04ff2"/>    <section>
    <title>model_to_bild_view_sphere()</title>
<indexterm><primary>model_to_bild_view_sphere</primary><secondary>rwmodel_bild.h</secondary></indexterm>
<indexterm><primary>rwmodel_bild.h</primary><secondary>model_to_bild_view_sphere</secondary></indexterm>
<para><computeroutput>int model_to_bild_view_sphere (<link linkend="_class_bstring">Bstring</link> &amp; filename, <link linkend="_struct_bmodel">Bmodel</link> * model, int color_type)</computeroutput></para><para>

<para>Converts a model into a representation with views. </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>bild format file name. </para>
</entry>
                            </row>
                            <row>
                                <entry>*model</entry>
                                <entry>
<para>model structure. </para>
</entry>
                            </row>
                            <row>
                                <entry>color_type</entry>
                                <entry>
<para>flag to color components. </para>
</entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                <formalpara><title>Returns: </title>

<para>int 0, &lt;0 on error. <literallayout><computeroutput>A sphere is drawn for every component with a cylinder indicating its view.
</computeroutput></literallayout> </para>
</formalpara>
</para>
<para>
Definition at line 362 of file rwmodel_bild.cpp.</para>
    </section><anchor xml:id="_rwmodel__bild_8h_1a4860aaca357985b9d9efce7a48ad70ee"/>    <section>
    <title>read_model_bild()</title>
<indexterm><primary>read_model_bild</primary><secondary>rwmodel_bild.h</secondary></indexterm>
<indexterm><primary>rwmodel_bild.h</primary><secondary>read_model_bild</secondary></indexterm>
<para><computeroutput><link linkend="_struct_bmodel">Bmodel</link>* read_model_bild (<link linkend="_class_bstring">Bstring</link> * file_list)</computeroutput></para><para>

<para>Reads Chimera BILD model 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>*file_list</entry>
                                <entry>
<para>list of model parameter file names. </para>
</entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                <formalpara><title>Returns: </title>

<para>Bmodel* model parameters. </para>
</formalpara>
</para>
<para>
Definition at line 43 of file rwmodel_bild.cpp.</para>
    </section><anchor xml:id="_rwmodel__bild_8h_1aee5f32ef4b7ede2128e09c96be9aed97"/>    <section>
    <title>write_model_bild()</title>
<indexterm><primary>write_model_bild</primary><secondary>rwmodel_bild.h</secondary></indexterm>
<indexterm><primary>rwmodel_bild.h</primary><secondary>write_model_bild</secondary></indexterm>
<para><computeroutput>int write_model_bild (<link linkend="_class_bstring">Bstring</link> &amp; filename, <link linkend="_struct_bmodel">Bmodel</link> * model)</computeroutput></para><para>

<para>Writes Chimera BILD model 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>&amp;filename</entry>
                                <entry>
<para>model parameter file name. </para>
</entry>
                            </row>
                            <row>
                                <entry>*model</entry>
                                <entry>
<para>model parameters. </para>
</entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                <formalpara><title>Returns: </title>

<para>int models written. </para>
</formalpara>
</para>
<para>
Definition at line 232 of file rwmodel_bild.cpp.</para>
</section>
</section>
</section>
