<?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="_bshow__helix_8tcl">
<title>/Users/bernard/b20/bsoft/tcltk/bshow_helix.tcl File Reference</title>
<indexterm><primary>/Users/bernard/b20/bsoft/tcltk/bshow_helix.tcl</primary></indexterm>
<para>

<para>Procedures to manage helical diffraction patterns. </para>
 
</para>
<simplesect>
    <title>Functions    </title>
        <itemizedlist>
            <listitem><para><link linkend="_bshow__helix_8tcl_1aeda1ee43ff0a57157a395f0d4f099458">Helix</link></para>

<para>Dialog box to manage helix information. </para>
</listitem>
            <listitem><para><link linkend="_bshow__helix_8tcl_1abcebdaa3b83a421756afcc5ff95c811f">setLayerLineIndex</link></para>

<para>Dialog box to set the index for the selected layer line. </para>
</listitem>
            <listitem><para><link linkend="_bshow__helix_8tcl_1a04428719c720b5a506ad459d502bc6ad">setLayerLineIndex_and_DestroyWindow</link> w</para>

<para>Sets the index for a layer line. </para>
</listitem>
            <listitem><para><link linkend="_bshow__helix_8tcl_1a83beae45f94b525d8576d0a32295d6f4">layerLineCreateSelect</link> x y</para>

<para>Creates or selects a layer line. </para>
</listitem>
            <listitem><para><link linkend="_bshow__helix_8tcl_1a2e1997aeffad9264be154583f120eea6">layerLineSelect</link> x y</para>

<para>Selects a layer line. </para>
</listitem>
            <listitem><para><link linkend="_bshow__helix_8tcl_1a787b5fa1c84ec841719eb72d5c0e8ae2">layerLineMove</link> x y</para>

<para>Moves the selected layer line location. </para>
</listitem>
            <listitem><para><link linkend="_bshow__helix_8tcl_1ad984f967ba7fd7929c2d68b8c724af79">drawHelixAxis</link></para>

<para>Draws a line along the helix axis on the canvas. </para>
</listitem>
            <listitem><para><link linkend="_bshow__helix_8tcl_1a64c0f5eedda2e6daf2910748aa112f7c">layerLineDraw</link> id</para>

<para>Draws a layer line in the original image on the canvas. </para>
</listitem>
            <listitem><para><link linkend="_bshow__helix_8tcl_1a2755c0bf0151e997565f52f5ee8f5fff">layerLinesDrawAll</link></para>

<para>Draws all layer lines on the canvas. </para>
</listitem>
            <listitem><para><link linkend="_bshow__helix_8tcl_1a017b1e709a8e39ff92554bc26143fd6e">layerLineDelete</link> x y</para>

<para>Deletes the selected layer line on the canvas. </para>
</listitem>
            <listitem><para><link linkend="_bshow__helix_8tcl_1a00b4811a2b123b61fe3d62254fbaefc4">layerLineDeleteAll</link></para>

<para>Deletes all layer lines in list. </para>
</listitem>
            <listitem><para><link linkend="_bshow__helix_8tcl_1adbd3d90c15ee24e5534c292154d78b8c">layerLinesGenerate</link></para>

<para>Generates layer lines from unit cell vectors. </para>
</listitem>
            <listitem><para><link linkend="_bshow__helix_8tcl_1a6dbf8e12be71c52c888388be875ddeae">layerLinesGenerate_and_DestroyWindow</link> w</para>

<para>Generates layer lines from unit cell vectors. </para>
</listitem>
            <listitem><para><link linkend="_bshow__helix_8tcl_1a1e63f289c0beec0d311e59d81e2e58d7">layerLinesMask</link></para>

<para>Masks layer lines. </para>
</listitem>
            <listitem><para><link linkend="_bshow__helix_8tcl_1a890fe8e45fb34a4076316150efa90fd8">layerLinePlot</link> id order rad</para>

<para>Plots the selected layer line in the plot canvas. </para>
</listitem>
            <listitem><para><link linkend="_bshow__helix_8tcl_1ad08aafdd0b4cb4c9161324c149ce5fa8">updateLayerLineParam</link></para>

<para>Updates layer line parameters from the micrograph parameters in memory. </para>
</listitem>
        </itemizedlist>
</simplesect>
<section>
<title>Detailed Description</title>

<para>Procedures to manage helical diffraction patterns. </para>

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

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

<para>Created: 20070516 </para>

<para>Modified: 20160203 </para>
</formalpara>
</para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_bshow__helix_8tcl_1ad984f967ba7fd7929c2d68b8c724af79"/>    <section>
    <title>drawHelixAxis()</title>
<indexterm><primary>drawHelixAxis</primary><secondary>bshow_helix.tcl</secondary></indexterm>
<indexterm><primary>bshow_helix.tcl</primary><secondary>drawHelixAxis</secondary></indexterm>
<para><computeroutput>drawHelixAxis</computeroutput></para><para>

<para>Draws a line along the helix axis on the canvas. </para>
</para>
<para>
Definition at line 336 of file bshow_helix.tcl.</para>
    </section><anchor xml:id="_bshow__helix_8tcl_1aeda1ee43ff0a57157a395f0d4f099458"/>    <section>
    <title>Helix()</title>
<indexterm><primary>Helix</primary><secondary>bshow_helix.tcl</secondary></indexterm>
<indexterm><primary>bshow_helix.tcl</primary><secondary>Helix</secondary></indexterm>
<para><computeroutput>Helix</computeroutput></para><para>

<para>Dialog box to manage helix information. </para>
</para>
<para>
Definition at line 22 of file bshow_helix.tcl.</para>
    </section><anchor xml:id="_bshow__helix_8tcl_1a83beae45f94b525d8576d0a32295d6f4"/>    <section>
    <title>layerLineCreateSelect()</title>
<indexterm><primary>layerLineCreateSelect</primary><secondary>bshow_helix.tcl</secondary></indexterm>
<indexterm><primary>bshow_helix.tcl</primary><secondary>layerLineCreateSelect</secondary></indexterm>
<para><computeroutput>layerLineCreateSelect x y </computeroutput></para><para>

<para>Creates or selects a layer line. </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>x</entry>
                                <entry>
<para></para>
</entry>
                            </row>
                            <row>
                                <entry>y</entry>
                                <entry>
<para>Layer line position in canvas coordinates. </para>
</entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                </para>
<para>
Definition at line 243 of file bshow_helix.tcl.</para>
    </section><anchor xml:id="_bshow__helix_8tcl_1a017b1e709a8e39ff92554bc26143fd6e"/>    <section>
    <title>layerLineDelete()</title>
<indexterm><primary>layerLineDelete</primary><secondary>bshow_helix.tcl</secondary></indexterm>
<indexterm><primary>bshow_helix.tcl</primary><secondary>layerLineDelete</secondary></indexterm>
<para><computeroutput>layerLineDelete x y </computeroutput></para><para>

<para>Deletes the selected layer line on the canvas. </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>x</entry>
                                <entry>
<para></para>
</entry>
                            </row>
                            <row>
                                <entry>y</entry>
                                <entry>
<para>Layer line position in window coordinates. </para>
</entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                </para>
<para>
Definition at line 443 of file bshow_helix.tcl.</para>
    </section><anchor xml:id="_bshow__helix_8tcl_1a00b4811a2b123b61fe3d62254fbaefc4"/>    <section>
    <title>layerLineDeleteAll()</title>
<indexterm><primary>layerLineDeleteAll</primary><secondary>bshow_helix.tcl</secondary></indexterm>
<indexterm><primary>bshow_helix.tcl</primary><secondary>layerLineDeleteAll</secondary></indexterm>
<para><computeroutput>layerLineDeleteAll</computeroutput></para><para>

<para>Deletes all layer lines in list. </para>
</para>
<para>
Definition at line 458 of file bshow_helix.tcl.</para>
    </section><anchor xml:id="_bshow__helix_8tcl_1a64c0f5eedda2e6daf2910748aa112f7c"/>    <section>
    <title>layerLineDraw()</title>
<indexterm><primary>layerLineDraw</primary><secondary>bshow_helix.tcl</secondary></indexterm>
<indexterm><primary>bshow_helix.tcl</primary><secondary>layerLineDraw</secondary></indexterm>
<para><computeroutput>layerLineDraw id </computeroutput></para><para>

<para>Draws a layer line in the original image on the canvas. </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>id</entry>
                                <entry>
<para>Layer line index. </para>
</entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                </para>
<para>
Definition at line 366 of file bshow_helix.tcl.</para>
    </section><anchor xml:id="_bshow__helix_8tcl_1a787b5fa1c84ec841719eb72d5c0e8ae2"/>    <section>
    <title>layerLineMove()</title>
<indexterm><primary>layerLineMove</primary><secondary>bshow_helix.tcl</secondary></indexterm>
<indexterm><primary>bshow_helix.tcl</primary><secondary>layerLineMove</secondary></indexterm>
<para><computeroutput>layerLineMove x y </computeroutput></para><para>

<para>Moves the selected layer line location. </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>x</entry>
                                <entry>
<para></para>
</entry>
                            </row>
                            <row>
                                <entry>y</entry>
                                <entry>
<para>Layer line position in canvas coordinates. </para>
</entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                </para>
<para>
Definition at line 311 of file bshow_helix.tcl.</para>
    </section><anchor xml:id="_bshow__helix_8tcl_1a890fe8e45fb34a4076316150efa90fd8"/>    <section>
    <title>layerLinePlot()</title>
<indexterm><primary>layerLinePlot</primary><secondary>bshow_helix.tcl</secondary></indexterm>
<indexterm><primary>bshow_helix.tcl</primary><secondary>layerLinePlot</secondary></indexterm>
<para><computeroutput>layerLinePlot id order rad </computeroutput></para><para>

<para>Plots the selected layer line in the plot canvas. </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>id</entry>
                                <entry>
<para>Layer line index. </para>
</entry>
                            </row>
                            <row>
                                <entry>order</entry>
                                <entry>
<para>Layer line order. </para>
</entry>
                            </row>
                            <row>
                                <entry>rad</entry>
                                <entry>
<para>Layer line length. </para>
</entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                </para>
<para>
Definition at line 540 of file bshow_helix.tcl.</para>
    </section><anchor xml:id="_bshow__helix_8tcl_1a2755c0bf0151e997565f52f5ee8f5fff"/>    <section>
    <title>layerLinesDrawAll()</title>
<indexterm><primary>layerLinesDrawAll</primary><secondary>bshow_helix.tcl</secondary></indexterm>
<indexterm><primary>bshow_helix.tcl</primary><secondary>layerLinesDrawAll</secondary></indexterm>
<para><computeroutput>layerLinesDrawAll</computeroutput></para><para>

<para>Draws all layer lines on the canvas. </para>
</para>
<para>
Definition at line 416 of file bshow_helix.tcl.</para>
    </section><anchor xml:id="_bshow__helix_8tcl_1a2e1997aeffad9264be154583f120eea6"/>    <section>
    <title>layerLineSelect()</title>
<indexterm><primary>layerLineSelect</primary><secondary>bshow_helix.tcl</secondary></indexterm>
<indexterm><primary>bshow_helix.tcl</primary><secondary>layerLineSelect</secondary></indexterm>
<para><computeroutput>layerLineSelect x y </computeroutput></para><para>

<para>Selects a layer line. </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>x</entry>
                                <entry>
<para></para>
</entry>
                            </row>
                            <row>
                                <entry>y</entry>
                                <entry>
<para>Layer line position in canvas coordinates. </para>
</entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                </para>
<para>
Definition at line 276 of file bshow_helix.tcl.</para>
    </section><anchor xml:id="_bshow__helix_8tcl_1adbd3d90c15ee24e5534c292154d78b8c"/>    <section>
    <title>layerLinesGenerate()</title>
<indexterm><primary>layerLinesGenerate</primary><secondary>bshow_helix.tcl</secondary></indexterm>
<indexterm><primary>bshow_helix.tcl</primary><secondary>layerLinesGenerate</secondary></indexterm>
<para><computeroutput>layerLinesGenerate</computeroutput></para><para>

<para>Generates layer lines from unit cell vectors. </para>
</para>
<para>
Definition at line 472 of file bshow_helix.tcl.</para>
    </section><anchor xml:id="_bshow__helix_8tcl_1a6dbf8e12be71c52c888388be875ddeae"/>    <section>
    <title>layerLinesGenerate_and_DestroyWindow()</title>
<indexterm><primary>layerLinesGenerate_and_DestroyWindow</primary><secondary>bshow_helix.tcl</secondary></indexterm>
<indexterm><primary>bshow_helix.tcl</primary><secondary>layerLinesGenerate_and_DestroyWindow</secondary></indexterm>
<para><computeroutput>layerLinesGenerate_and_DestroyWindow w </computeroutput></para><para>

<para>Generates layer lines from unit cell vectors. </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>w</entry>
                                <entry>
<para>the window to destroy. </para>
</entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                </para>
<para>
Definition at line 500 of file bshow_helix.tcl.</para>
    </section><anchor xml:id="_bshow__helix_8tcl_1a1e63f289c0beec0d311e59d81e2e58d7"/>    <section>
    <title>layerLinesMask()</title>
<indexterm><primary>layerLinesMask</primary><secondary>bshow_helix.tcl</secondary></indexterm>
<indexterm><primary>bshow_helix.tcl</primary><secondary>layerLinesMask</secondary></indexterm>
<para><computeroutput>layerLinesMask</computeroutput></para><para>

<para>Masks layer lines. </para>
</para>
<para>
Definition at line 525 of file bshow_helix.tcl.</para>
    </section><anchor xml:id="_bshow__helix_8tcl_1abcebdaa3b83a421756afcc5ff95c811f"/>    <section>
    <title>setLayerLineIndex()</title>
<indexterm><primary>setLayerLineIndex</primary><secondary>bshow_helix.tcl</secondary></indexterm>
<indexterm><primary>bshow_helix.tcl</primary><secondary>setLayerLineIndex</secondary></indexterm>
<para><computeroutput>setLayerLineIndex</computeroutput></para><para>

<para>Dialog box to set the index for the selected layer line. </para>
</para>
<para>
Definition at line 159 of file bshow_helix.tcl.</para>
    </section><anchor xml:id="_bshow__helix_8tcl_1a04428719c720b5a506ad459d502bc6ad"/>    <section>
    <title>setLayerLineIndex_and_DestroyWindow()</title>
<indexterm><primary>setLayerLineIndex_and_DestroyWindow</primary><secondary>bshow_helix.tcl</secondary></indexterm>
<indexterm><primary>bshow_helix.tcl</primary><secondary>setLayerLineIndex_and_DestroyWindow</secondary></indexterm>
<para><computeroutput>setLayerLineIndex_and_DestroyWindow w </computeroutput></para><para>

<para>Sets the index for a layer line. </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>w</entry>
                                <entry>
<para>the window to destroy. </para>
</entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                </para>
<para>
Definition at line 209 of file bshow_helix.tcl.</para>
    </section><anchor xml:id="_bshow__helix_8tcl_1ad08aafdd0b4cb4c9161324c149ce5fa8"/>    <section>
    <title>updateLayerLineParam()</title>
<indexterm><primary>updateLayerLineParam</primary><secondary>bshow_helix.tcl</secondary></indexterm>
<indexterm><primary>bshow_helix.tcl</primary><secondary>updateLayerLineParam</secondary></indexterm>
<para><computeroutput>updateLayerLineParam</computeroutput></para><para>

<para>Updates layer line parameters from the micrograph parameters in memory. </para>
</para>
<para>
Definition at line 593 of file bshow_helix.tcl.</para>
</section>
</section>
</section>
