diff options
Diffstat (limited to '2.3-1/help/en_US')
37 files changed, 4 insertions, 2745 deletions
diff --git a/2.3-1/help/en_US/AVRADCSetup.xml b/2.3-1/help/en_US/AVRADCSetup.xml deleted file mode 100644 index a0abf030..00000000 --- a/2.3-1/help/en_US/AVRADCSetup.xml +++ /dev/null @@ -1,83 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> - -<!-- - * - * This help file was generated from AVRADCSetup.sci using help_from_sci(). - * - --> - -<refentry version="5.0-subset Scilab" xml:id="AVRADCSetup" xml:lang="en" - xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:svg="http://www.w3.org/2000/svg" - xmlns:ns3="http://www.w3.org/1999/xhtml" - xmlns:mml="http://www.w3.org/1998/Math/MathML" - xmlns:scilab="http://www.scilab.org" - xmlns:db="http://docbook.org/ns/docbook"> - - <refnamediv> - <refname>AVRADCSetup</refname> - <refpurpose>Function to initialise ADC of AVR</refpurpose> - </refnamediv> - - -<refsynopsisdiv> - <title>Calling Sequence</title> - <synopsis> - AVRADCSetup(uint8 prescaler, uint8 adc_ref) - - </synopsis> -</refsynopsisdiv> - -<refsection> - <title>Parameters</title> - <variablelist> - <varlistentry><term>prescaler:</term> - <listitem><para> prescaler to be used for generating ADC clock (0-7)</para></listitem></varlistentry> - <varlistentry><term>adc_ref :</term> - <listitem><para> reference voltage to be used for ADC conversion</para></listitem></varlistentry> - </variablelist> -</refsection> - -<refsection> - <title>Description</title> - <para> -This function initialises ADc of AVR with given parameters. 'prescaler' is needed for deciding ADC clock. ADC clock should be between 50KHz and 200KHz and it given as (MCU clock/2^prescaler). Select appropriate prescaler depending on MCU clock. 'adc_ref' selects one of the available reference voltage sources available. - </para> - <para> -The adc_ref can take the following values- -<itemizedlist> -<listitem><para>0 -> Voltage on VREF pin</para></listitem> -<listitem><para>1 -> Voltage on AVCC pin</para></listitem> -<listitem><para>2 -> Internal 2.56 reference voltage</para></listitem> -</itemizedlist> - </para> - <para> -This is curretly dummy function. It provides no functionality but is required for providing support for generating C code for AVR. - </para> - <para> -</para> -</refsection> - -<refsection> - <title>Examples</title> - <programlisting role="example"><![CDATA[ -AVRADCSetup(128,0) - ]]></programlisting> -</refsection> - -<refsection> - <title>See also</title> - <simplelist type="inline"> - <member><link linkend="AVRReadADC">AVRReadADC</link></member> - </simplelist> -</refsection> - -<refsection> - <title>Authors</title> - <simplelist type="vert"> - <member>Siddhesh Wani</member> - <member>Ashish Kamble</member> - </simplelist> -</refsection> -</refentry> diff --git a/2.3-1/help/en_US/AVRDigitalIn.xml b/2.3-1/help/en_US/AVRDigitalIn.xml deleted file mode 100644 index ef87407c..00000000 --- a/2.3-1/help/en_US/AVRDigitalIn.xml +++ /dev/null @@ -1,79 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> - -<!-- - * - * This help file was generated from AVRDigitalIn.sci using help_from_sci(). - * - --> - -<refentry version="5.0-subset Scilab" xml:id="AVRDigitalIn" xml:lang="en" - xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:svg="http://www.w3.org/2000/svg" - xmlns:ns3="http://www.w3.org/1999/xhtml" - xmlns:mml="http://www.w3.org/1998/Math/MathML" - xmlns:scilab="http://www.scilab.org" - xmlns:db="http://docbook.org/ns/docbook"> - - <refnamediv> - <refname>AVRDigitalIn</refname> - <refpurpose>Function to get state (high\low) of a digital input pin on AVR</refpurpose> - </refnamediv> - - -<refsynopsisdiv> - <title>Calling Sequence</title> - <synopsis> - state=AVRDigitalIn(port,pin) - - </synopsis> -</refsynopsisdiv> - -<refsection> - <title>Parameters</title> - <variablelist> - <varlistentry><term>port :</term> - <listitem><para> port of microcontroller to be used</para></listitem></varlistentry> - <varlistentry><term>pin :</term> - <listitem><para> pin of port (mentioned above) to be used</para></listitem></varlistentry> - </variablelist> -</refsection> - -<refsection> - <title>Description</title> - <para> -Each AVR microcontroller has pins which can be configured as digital -inputs. These are normally divided among some 'ports' (group of pins). -User has to select one of these port and which pin of that port as -digital input. - </para> - <para> -This is curretly dummy function. It provides no functionality but is required -for providing support for generating C code for AVR. - </para> - <para> -</para> -</refsection> - -<refsection> - <title>Examples</title> - <programlisting role="example"><![CDATA[ -pinA0 = AVRDigitalIn(1,0) //To read state on pin 0 of port A - ]]></programlisting> -</refsection> - -<refsection> - <title>See also</title> - <simplelist type="inline"> - <member><link linkend="AVRDigitalOut">AVRDigitalSetup</link></member> - </simplelist> -</refsection> - -<refsection> - <title>Authors</title> - <simplelist type="vert"> - <member>Siddhesh Wani</member> - <member>Ashish Kamble</member> - </simplelist> -</refsection> -</refentry> diff --git a/2.3-1/help/en_US/AVRDigitalOut.xml b/2.3-1/help/en_US/AVRDigitalOut.xml deleted file mode 100644 index 0ce8197f..00000000 --- a/2.3-1/help/en_US/AVRDigitalOut.xml +++ /dev/null @@ -1,82 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> - -<!-- - * - * This help file was generated from AVRDigitalOut.sci using help_from_sci(). - * - --> - -<refentry version="5.0-subset Scilab" xml:id="AVRDigitalOut" xml:lang="en" - xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:svg="http://www.w3.org/2000/svg" - xmlns:ns3="http://www.w3.org/1999/xhtml" - xmlns:mml="http://www.w3.org/1998/Math/MathML" - xmlns:scilab="http://www.scilab.org" - xmlns:db="http://docbook.org/ns/docbook"> - - <refnamediv> - <refname>AVRDigitalOut</refname> - <refpurpose>Function to change state (high\low) of a digital output pin on AVR</refpurpose> - </refnamediv> - - -<refsynopsisdiv> - <title>Calling Sequence</title> - <synopsis> - AVRDigitalOut(port,pin,state) - - </synopsis> -</refsynopsisdiv> - -<refsection> - <title>Parameters</title> - <variablelist> - <varlistentry><term>port :</term> - <listitem><para> port of microcontroller to be used</para></listitem></varlistentry> - <varlistentry><term>pin :</term> - <listitem><para> pin of port (mentioned above) to be used</para></listitem></varlistentry> - <varlistentry><term>state :</term> - <listitem><para> state to be outputed on pin (HIGH\LOW)</para></listitem></varlistentry> - </variablelist> -</refsection> - -<refsection> - <title>Description</title> - <para> -Each AVR microcontroller has pins which can be configured as digital -outputs. These are normally divided among some 'ports' (group of pins). -User has to select one of these port and which pin of that port as -digital output. Also, desired output state must be specified as -'HIGH' or 'LOW'. - </para> - <para> -This is curretly dummy function. It provides no functionality but is required -for providing support for generating C code for AVR. - </para> - <para> -</para> -</refsection> - -<refsection> - <title>Examples</title> - <programlisting role="example"><![CDATA[ -AVRDigitalOut('A',0,HIGH) - ]]></programlisting> -</refsection> - -<refsection> - <title>See also</title> - <simplelist type="inline"> - <member><link linkend="AVRDigitalIn">AVRDigitalIn</link></member> - </simplelist> -</refsection> - -<refsection> - <title>Authors</title> - <simplelist type="vert"> - <member>Siddhesh Wani</member> - <member>Ashish Kamble</member> - </simplelist> -</refsection> -</refentry> diff --git a/2.3-1/help/en_US/AVRDigitalPortSetup.xml b/2.3-1/help/en_US/AVRDigitalPortSetup.xml deleted file mode 100644 index 8b7b15dc..00000000 --- a/2.3-1/help/en_US/AVRDigitalPortSetup.xml +++ /dev/null @@ -1,81 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> - -<!-- - * - * This help file was generated from AVRDigitalPortSetup.sci using help_from_sci(). - * - --> - -<refentry version="5.0-subset Scilab" xml:id="AVRDigitalPortSetup" xml:lang="en" - xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:svg="http://www.w3.org/2000/svg" - xmlns:ns3="http://www.w3.org/1999/xhtml" - xmlns:mml="http://www.w3.org/1998/Math/MathML" - xmlns:scilab="http://www.scilab.org" - xmlns:db="http://docbook.org/ns/docbook"> - - <refnamediv> - <refname>AVRDigitalPortSetup</refname> - <refpurpose>Function to decide direction of port on AVR</refpurpose> - </refnamediv> - - -<refsynopsisdiv> - <title>Calling Sequence</title> - <synopsis> - AVRDigitalPortSetup(port,direction) - - </synopsis> -</refsynopsisdiv> - -<refsection> - <title>Parameters</title> - <variablelist> - <varlistentry><term>port :</term> - <listitem><para> port of microcontroller to be used(1 for PORTA, 2 for PORTB,...)</para></listitem></varlistentry> - <varlistentry><term>direction :</term> - <listitem><para> direction to be set for pin (0 for INPUT, 1 for OUTPUT)</para></listitem></varlistentry> - </variablelist> -</refsection> - -<refsection> - <title>Description</title> - <para> -Each AVR microcontroller has pins which can be configured as digital -outputs/inputs. These are normally divided among some 'ports' (group of pins). -User has to select one of these port and which pin of that port to be -used as digital output/input. Also, desired direction must be specified as -'INPUT' or 'OUTPUT'. - </para> - <para> -This is curretly dummy function. It provides no functionality but is required -for providing support for generating C code for AVR. - </para> - <para> -</para> -</refsection> - -<refsection> - <title>Examples</title> - <programlisting role="example"><![CDATA[ -AVRDigitalPortSetup(1,0); //This function will make PortA as input port - - ]]></programlisting> -</refsection> - -<refsection> - <title>See also</title> - <simplelist type="inline"> - <member><link linkend="AVRDigitalIn">AVRDigitalOut</link></member> - </simplelist> -</refsection> - -<refsection> - <title>Authors</title> - <simplelist type="vert"> - <member>Siddhesh Wani</member> - <member>Ashish Kamble</member> - </simplelist> -</refsection> -</refentry> diff --git a/2.3-1/help/en_US/AVRDigitalSetup.xml b/2.3-1/help/en_US/AVRDigitalSetup.xml deleted file mode 100644 index a2285730..00000000 --- a/2.3-1/help/en_US/AVRDigitalSetup.xml +++ /dev/null @@ -1,83 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> - -<!-- - * - * This help file was generated from AVRDigitalSetup.sci using help_from_sci(). - * - --> - -<refentry version="5.0-subset Scilab" xml:id="AVRDigitalSetup" xml:lang="en" - xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:svg="http://www.w3.org/2000/svg" - xmlns:ns3="http://www.w3.org/1999/xhtml" - xmlns:mml="http://www.w3.org/1998/Math/MathML" - xmlns:scilab="http://www.scilab.org" - xmlns:db="http://docbook.org/ns/docbook"> - - <refnamediv> - <refname>AVRDigitalSetup</refname> - <refpurpose>Function to decide direction of a digital pin on AVR</refpurpose> - </refnamediv> - - -<refsynopsisdiv> - <title>Calling Sequence</title> - <synopsis> - AVRDigitalSetup(port,pin,direction) - - </synopsis> -</refsynopsisdiv> - -<refsection> - <title>Parameters</title> - <variablelist> - <varlistentry><term>port :</term> - <listitem><para> port of microcontroller to be used</para></listitem></varlistentry> - <varlistentry><term>pin :</term> - <listitem><para> pin of port (mentioned above) to be used</para></listitem></varlistentry> - <varlistentry><term>direction :</term> - <listitem><para> direction to be set for pin (INPUT\OUTPUT)</para></listitem></varlistentry> - </variablelist> -</refsection> - -<refsection> - <title>Description</title> - <para> -Each AVR microcontroller has pins which can be configured as digital -outputs/inputs. These are normally divided among some 'ports' (group of pins). -User has to select one of these port and which pin of that port to be -used as digital output/input. Also, desired direction must be specified as -'INPUT' or 'OUTPUT'. - </para> - <para> -This is curretly dummy function. It provides no functionality but is required -for providing support for generating C code for AVR. - </para> - <para> -</para> -</refsection> - -<refsection> - <title>Examples</title> - <programlisting role="example"><![CDATA[ -AVRDigitalSetup('A',0,OUTPUT) - - ]]></programlisting> -</refsection> - -<refsection> - <title>See also</title> - <simplelist type="inline"> - <member><link linkend="AVRDigitalIn">AVRDigitalOut</link></member> - </simplelist> -</refsection> - -<refsection> - <title>Authors</title> - <simplelist type="vert"> - <member>Siddhesh Wani</member> - <member>Ashish Kamble</member> - </simplelist> -</refsection> -</refentry> diff --git a/2.3-1/help/en_US/AVRGetTimerValue.xml b/2.3-1/help/en_US/AVRGetTimerValue.xml deleted file mode 100644 index f639c60d..00000000 --- a/2.3-1/help/en_US/AVRGetTimerValue.xml +++ /dev/null @@ -1,73 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> - -<!-- - * - * This help file was generated from AVRGetTimerValue.sci using help_from_sci(). - * - --> - -<refentry version="5.0-subset Scilab" xml:id="AVRGetTimerValue" xml:lang="en" - xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:svg="http://www.w3.org/2000/svg" - xmlns:ns3="http://www.w3.org/1999/xhtml" - xmlns:mml="http://www.w3.org/1998/Math/MathML" - xmlns:scilab="http://www.scilab.org" - xmlns:db="http://docbook.org/ns/docbook"> - - <refnamediv> - <refname>AVRGetTimerValue</refname> - <refpurpose>Function to get timer count</refpurpose> - </refnamediv> - - -<refsection> - <title>Parameters</title> - <variablelist> - <varlistentry><term>timer :</term> - <listitem><para> timer whose current count is to be returned</para></listitem></varlistentry> - </variablelist> -</refsection> - -<refsection> - <title>Description</title> - <para> -This function returns the count value of a desired timer.By knowing the count value certain interrupt action can be taken. - </para> - <para> -Timer can take the following values -<itemizedlist> -<listitem><para>0 -> for timer0</para></listitem> -<listitem><para>1 -> for timer1</para></listitem> -<listitem><para>2 -> for timer2</para></listitem> -</itemizedlist> - </para> - <para> -This is curretly dummy function. It provides no functionality but is required -for providing support for generating C code for AVR. - </para> - <para> -</para> -</refsection> - -<refsection> - <title>Examples</title> - <programlisting role="example"><![CDATA[ -AVRGetTimerValue(0); //returns present count of the TCNT0 counter - ]]></programlisting> -</refsection> - -<refsection> - <title>See also</title> - <simplelist type="inline"> - <member><link linkend="AVRTimerSetup">AVRTimerSetup</link></member> - </simplelist> -</refsection> - -<refsection> - <title>Authors</title> - <simplelist type="vert"> - <member>Ashish Kamble</member> - </simplelist> -</refsection> -</refentry> diff --git a/2.3-1/help/en_US/AVRPWM0SetDuty.xml b/2.3-1/help/en_US/AVRPWM0SetDuty.xml deleted file mode 100644 index a3f26812..00000000 --- a/2.3-1/help/en_US/AVRPWM0SetDuty.xml +++ /dev/null @@ -1,66 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> - -<!-- - * - * This help file was generated from AVRPWM0SetDuty.sci using help_from_sci(). - * - --> - -<refentry version="5.0-subset Scilab" xml:id="AVRPWM0SetDuty" xml:lang="en" - xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:svg="http://www.w3.org/2000/svg" - xmlns:ns3="http://www.w3.org/1999/xhtml" - xmlns:mml="http://www.w3.org/1998/Math/MathML" - xmlns:scilab="http://www.scilab.org" - xmlns:db="http://docbook.org/ns/docbook"> - - <refnamediv> - <refname>AVRPWM0SetDuty</refname> - <refpurpose>Function to Set Duty cycle of PWM Output generated by Timer0 at OC0 pin.</refpurpose> - </refnamediv> - - -<refsection> - <title>Parameters</title> - <variablelist> - <varlistentry><term>duty :</term> - <listitem><para> It holds an integer value from 0 to 100 which sets the percentage of time for which signal is active.</para></listitem></varlistentry> - </variablelist> -</refsection> - -<refsection> - <title>Description</title> - <para> -Each Micro controller has PWM output pins which can generate varying voltage -from 0V-5V.In this function by varying the duty cycle, varying voltage can be produced. - </para> - <para> -This is curretly dummy function. It provides no functionality but is required for providing support for generating C code for AVR. - </para> - <para> -</para> -</refsection> - -<refsection> - <title>Examples</title> - <programlisting role="example"><![CDATA[ -AVRPWM0SetDuty(50); //Produces 2.5V at OC0 pin -AVRPWM0SetDuty(0); //Produces 0V at OC0 pin - ]]></programlisting> -</refsection> - -<refsection> - <title>See also</title> - <simplelist type="inline"> - <member><link linkend="AVRPWM0Setup">AVRPWM0Setup</link></member> - </simplelist> -</refsection> - -<refsection> - <title>Authors</title> - <simplelist type="vert"> - <member>Ashish Kamble</member> - </simplelist> -</refsection> -</refentry> diff --git a/2.3-1/help/en_US/AVRPWM0Setup.xml b/2.3-1/help/en_US/AVRPWM0Setup.xml deleted file mode 100644 index f72f2582..00000000 --- a/2.3-1/help/en_US/AVRPWM0Setup.xml +++ /dev/null @@ -1,92 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> - -<!-- - * - * This help file was generated from AVRPWM0Setup.sci using help_from_sci(). - * - --> - -<refentry version="5.0-subset Scilab" xml:id="AVRPWM0Setup" xml:lang="en" - xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:svg="http://www.w3.org/2000/svg" - xmlns:ns3="http://www.w3.org/1999/xhtml" - xmlns:mml="http://www.w3.org/1998/Math/MathML" - xmlns:scilab="http://www.scilab.org" - xmlns:db="http://docbook.org/ns/docbook"> - - <refnamediv> - <refname>AVRPWM0Setup</refname> - <refpurpose>Function to Setup OC0 pin for required PWM mode</refpurpose> - </refnamediv> - - -<refsection> - <title>Parameters</title> - <variablelist> - <varlistentry><term>waveform_mode:</term> - <listitem><para> integer, from 0 to 2</para></listitem></varlistentry> - <varlistentry><term>output_mode:</term> - <listitem><para> integer, from 0 to 1 (or 2) depending on the waveform_mode</para></listitem></varlistentry> - </variablelist> -</refsection> - -<refsection> - <title>Description</title> - <para> -Every Micro controller has PWM pins which can generate varying voltages -from 0V-5V.This function helps to use OC0 pin to produce required -output waveform by setting the waveform mode and otput mode. - </para> - <para> -waveform_mode can take values- -<itemizedlist> -<listitem><para>0 -> for Phase correct PWM Mode</para></listitem> -<listitem><para>1 -> for Fast PWM Mode</para></listitem> -<listitem><para>2 -> for CTC Mode</para></listitem> -</itemizedlist> - </para> - <para> -output_mode can take values- -<itemizedlist> -For Phase correct PWM Mode: -<listitem><para>0 for Clear OC0 on compare match when up-counting. Set OC0 on compare match when down-counting.</para></listitem> -<listitem><para>1 for Set OC0 on compare match when up-counting. Clear OC0 on compare match when down-counting.</para></listitem> -For Fast PWM Mode: -<listitem><para>0 for non-inverted output i.e Clear OC0 on compare match, set OC0 at BOTTOM.</para></listitem> -<listitem><para>1 for inverted output i.e Set OC0 on compare match, clear OC0 at BOTTOM.</para></listitem> -For CTC Mode: -<listitem><para>0 to Clear OC0 on compare match</para></listitem> -<listitem><para>1 to Set OC0 on compare match</para></listitem> -<listitem><para>2 to toggle OC0 on compare match</para></listitem> -</itemizedlist> - </para> - <para> -This is curretly dummy function. It provides no functionality but is required -for providing support for generating C code for AVR. - </para> - <para> -</para> -</refsection> - -<refsection> - <title>Examples</title> - <programlisting role="example"><![CDATA[ -AVRPWM0Setup(2,0); //This function will select CTC waveform mode and will clear OC0 on compare match - ]]></programlisting> -</refsection> - -<refsection> - <title>See also</title> - <simplelist type="inline"> - <member><link linkend="AVRPWM0SetDuty">AVRPWM0SetDuty</link></member> - </simplelist> -</refsection> - -<refsection> - <title>Authors</title> - <simplelist type="vert"> - <member>Ashish Kamble</member> - </simplelist> -</refsection> -</refentry> diff --git a/2.3-1/help/en_US/AVRPWM1SetDuty.xml b/2.3-1/help/en_US/AVRPWM1SetDuty.xml deleted file mode 100644 index 83230ea8..00000000 --- a/2.3-1/help/en_US/AVRPWM1SetDuty.xml +++ /dev/null @@ -1,66 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> - -<!-- - * - * This help file was generated from AVRPWM1SetDuty.sci using help_from_sci(). - * - --> - -<refentry version="5.0-subset Scilab" xml:id="AVRPWM1SetDuty" xml:lang="en" - xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:svg="http://www.w3.org/2000/svg" - xmlns:ns3="http://www.w3.org/1999/xhtml" - xmlns:mml="http://www.w3.org/1998/Math/MathML" - xmlns:scilab="http://www.scilab.org" - xmlns:db="http://docbook.org/ns/docbook"> - - <refnamediv> - <refname>AVRPWM1SetDuty</refname> - <refpurpose>Function to Set Duty cycle of PWM Output generated by Timer1 at OC1A or OC1B pin.</refpurpose> - </refnamediv> - - -<refsection> - <title>Parameters</title> - <variablelist> - <varlistentry><term>ouput_pin:</term> - <listitem><para> integer, 0 (for OC1A) or 1 (for OC1B)</para></listitem></varlistentry> - <varlistentry><term>duty:</term> - <listitem><para> It holds an integer value from 0 to 100 which sets the percentage of time for which signal is active.</para></listitem></varlistentry> - <varlistentry><term>Top_Value:</term> - <listitem><para> It holds an integer value from 0 to 65535.This value sets the Top value of the counter TCNT1 i.e ICR.(for more info refer datasheet)</para></listitem></varlistentry> - </variablelist> -</refsection> - -<refsection> - <title>Description</title> - <para> -Each Micro controller has PWM output pins which can generate varying voltage -from 0V-5V.This function Sets the duty cycle of output PWM signal.Also this function -decides the Top Vale of TCNT1 and the output pin to output PWM signal. - </para> - <para> -This is curretly dummy function. It provides no functionality but is required -for providing support for generating C code for AVR. - </para> - <para> -Example -AVRPWM1SetDuty(0,50,40000); //This function will produce PWM signal of 50% duty cycle on OC1A pin and TCNT1 will reset at 40000 instead at 65535. -</para> -</refsection> - -<refsection> - <title>See also</title> - <simplelist type="inline"> - <member><link linkend="AVRPWM1Setup">AVRPWM1Setup</link></member> - </simplelist> -</refsection> - -<refsection> - <title>Authors</title> - <simplelist type="vert"> - <member>Ashish Kamble</member> - </simplelist> -</refsection> -</refentry> diff --git a/2.3-1/help/en_US/AVRPWM1Setup.xml b/2.3-1/help/en_US/AVRPWM1Setup.xml deleted file mode 100644 index 14984130..00000000 --- a/2.3-1/help/en_US/AVRPWM1Setup.xml +++ /dev/null @@ -1,91 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> - -<!-- - * - * This help file was generated from AVRPWM1Setup.sci using help_from_sci(). - * - --> - -<refentry version="5.0-subset Scilab" xml:id="AVRPWM1Setup" xml:lang="en" - xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:svg="http://www.w3.org/2000/svg" - xmlns:ns3="http://www.w3.org/1999/xhtml" - xmlns:mml="http://www.w3.org/1998/Math/MathML" - xmlns:scilab="http://www.scilab.org" - xmlns:db="http://docbook.org/ns/docbook"> - - <refnamediv> - <refname>AVRPWM1Setup</refname> - <refpurpose>Function to Setup OC1A or OC1B pin for required PWM mode</refpurpose> - </refnamediv> - - -<refsection> - <title>Parameters</title> - <variablelist> - <varlistentry><term>waveform_mode:</term> - <listitem><para> integer, from 0 to 2</para></listitem></varlistentry> - <varlistentry><term>output_mode:</term> - <listitem><para> integer, from 0 to 1 (or 2) depending on the waveform_mode</para></listitem></varlistentry> - <varlistentry><term>output_pin:</term> - <listitem><para> 0 (for OC1A) or 1 for (OC1B)</para></listitem></varlistentry> - </variablelist> -</refsection> - -<refsection> - <title>Description</title> - <para> -Every Micro controller has PWM pins which can generate varying voltages -from 0V-5V.This function helps to use OC1A or OC1B pin to produces required -output waveform by setting the waveform mode and otput mode. - </para> - <para> -waveform_mode can take values- -<itemizedlist> -<listitem><para>0 -> for Phase correct PWM Mode</para></listitem> -<listitem><para>1 -> for Fast PWM Mode</para></listitem> -<listitem><para>2 -> for CTC Mode</para></listitem> -</itemizedlist> - </para> - <para> -output_mode can take values- -<itemizedlist> -For Phase correct PWM Mode: -<listitem><para>0 for Clear OC1A or OC1B on compare match when up-counting. Set OC1A or OC1B on compare match when down-counting.</para></listitem> -<listitem><para>1 for Set OC1A or OC1B on compare match when up-counting. Clear OC1A or OC1B on compare match when down-counting.</para></listitem> -For Fast PWM Mode: -<listitem><para>0 for non-inverted output i.e Clear OC1A or OC1B on compare match, set OC1A or OC1B at BOTTOM.</para></listitem> -<listitem><para>1 for inverted output i.e Set OC1A or OC1B on compare match, clear OC1A or OC1B at BOTTOM.</para></listitem> -For CTC Mode: -<listitem><para>0 to Clear OC1A or OC1B on compare match</para></listitem> -<listitem><para>1 to Set OC1A or OC1B on compare match</para></listitem> -<listitem><para>2 to toggle OC1A or OC1B on compare match</para></listitem> -</itemizedlist> - </para> - <para> -This is curretly dummy function. It provides no functionality but is required -for providing support for generating C code for AVR. - </para> - <para> -Example -AVRPWM1Setup(2,0,0); //This function will select CTC mode and will clear OC1A or OC1B -on compare match.Also as defined the output will be produced at -0C1A pin. -</para> -</refsection> - -<refsection> - <title>See also</title> - <simplelist type="inline"> - <member><link linkend="AVRPWM1SetDuty">AVRPWM1SetDuty</link></member> - </simplelist> -</refsection> - -<refsection> - <title>Authors</title> - <simplelist type="vert"> - <member>Ashish Kamble</member> - </simplelist> -</refsection> -</refentry> diff --git a/2.3-1/help/en_US/AVRPWM2SetDuty.xml b/2.3-1/help/en_US/AVRPWM2SetDuty.xml deleted file mode 100644 index d44f0f71..00000000 --- a/2.3-1/help/en_US/AVRPWM2SetDuty.xml +++ /dev/null @@ -1,65 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> - -<!-- - * - * This help file was generated from AVRPWM2SetDuty.sci using help_from_sci(). - * - --> - -<refentry version="5.0-subset Scilab" xml:id="AVRPWM2SetDuty" xml:lang="en" - xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:svg="http://www.w3.org/2000/svg" - xmlns:ns3="http://www.w3.org/1999/xhtml" - xmlns:mml="http://www.w3.org/1998/Math/MathML" - xmlns:scilab="http://www.scilab.org" - xmlns:db="http://docbook.org/ns/docbook"> - - <refnamediv> - <refname>AVRPWM2SetDuty</refname> - <refpurpose>Function to Set Duty cycle of PWM Output generated by Timer2 at OC2 pin.</refpurpose> - </refnamediv> - - -<refsection> - <title>Parameters</title> - <variablelist> - <varlistentry><term>duty :</term> - <listitem><para> It holds an integer value from 0 to 100 which sets the percentage of time for which signal is active.</para></listitem></varlistentry> - </variablelist> -</refsection> - -<refsection> - <title>Description</title> - <para> -Each Micro controller has PWM output pins which can generate varying voltage -from 0V-5V.In this function by varying the duty cycle, varying voltage can be -produced. - </para> - <para> -This is curretly dummy function. It provides no functionality but is required -for providing support for generating C code for AVR. - </para> - <para> -Example -AVRPWM2SetDuty(50); //Produces 2.5V at OC2 pin -AVRPWM2SetDuty(0); //Produces 0V at OC2 pin - </para> - <para> -</para> -</refsection> - -<refsection> - <title>See also</title> - <simplelist type="inline"> - <member><link linkend="AVRPWM2Setup">AVRPWM2Setup</link></member> - </simplelist> -</refsection> - -<refsection> - <title>Authors</title> - <simplelist type="vert"> - <member>Ashish Kamble</member> - </simplelist> -</refsection> -</refentry> diff --git a/2.3-1/help/en_US/AVRPWM2Setup.xml b/2.3-1/help/en_US/AVRPWM2Setup.xml deleted file mode 100644 index fe802522..00000000 --- a/2.3-1/help/en_US/AVRPWM2Setup.xml +++ /dev/null @@ -1,88 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> - -<!-- - * - * This help file was generated from AVRPWM2Setup.sci using help_from_sci(). - * - --> - -<refentry version="5.0-subset Scilab" xml:id="AVRPWM2Setup" xml:lang="en" - xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:svg="http://www.w3.org/2000/svg" - xmlns:ns3="http://www.w3.org/1999/xhtml" - xmlns:mml="http://www.w3.org/1998/Math/MathML" - xmlns:scilab="http://www.scilab.org" - xmlns:db="http://docbook.org/ns/docbook"> - - <refnamediv> - <refname>AVRPWM2Setup</refname> - <refpurpose>Function to Setup OC2 pin for required PWM mode</refpurpose> - </refnamediv> - - -<refsection> - <title>Parameters</title> - <variablelist> - <varlistentry><term>waveform_mode:</term> - <listitem><para> integer, from 0 to 2</para></listitem></varlistentry> - <varlistentry><term>output_mode:</term> - <listitem><para> integer, from 0 to 1 (or 2) depending on the waveform_mode</para></listitem></varlistentry> - </variablelist> -</refsection> - -<refsection> - <title>Description</title> - <para> -Every Micro controller has PWM pins which can generate varying voltages -from 0V-5V.This function helps to use OC2 pin to produces required -output waveform by setting the waveform mode and otput mode. - </para> - <para> -waveform_mode can take values- -<itemizedlist> -<listitem><para>0 -> for Phase correct PWM Mode</para></listitem> -<listitem><para>1 -> for Fast PWM Mode</para></listitem> -<listitem><para>2 -> for CTC Mode</para></listitem> -</itemizedlist> - </para> - <para> -output_mode can take values- -<itemizedlist> -For Phase correct PWM Mode: -<listitem><para>0 for Clear OC2 on compare match when up-counting. Set OC2 on compare match when down-counting.</para></listitem> -<listitem><para>1 for Set OC2 on compare match when up-counting. Clear OC2 on compare match when down-counting.</para></listitem> -For Fast PWM Mode: -<listitem><para>0 for non-inverted output i.e Clear OC2 on compare match, set OC2 at BOTTOM.</para></listitem> -<listitem><para>1 for inverted output i.e Set OC2 on compare match, clear OC2 at BOTTOM.</para></listitem> -For CTC Mode: -<listitem><para>0 to Clear OC2 on compare match</para></listitem> -<listitem><para>1 to Set OC2 on compare match</para></listitem> -<listitem><para>2 to toggle OC2 on compare match</para></listitem> -</itemizedlist> - </para> - <para> -This is curretly dummy function. It provides no functionality but is required -for providing support for generating C code for AVR. - </para> - <para> -Example -AVRPWM2Setup(2,0); //This function will select CTC waveform mode and will clear OC2 on -compare match -</para> -</refsection> - -<refsection> - <title>See also</title> - <simplelist type="inline"> - <member><link linkend="AVRPWM2SetDuty">AVRPWM2SetDuty</link></member> - </simplelist> -</refsection> - -<refsection> - <title>Authors</title> - <simplelist type="vert"> - <member>Ashish Kamble</member> - </simplelist> -</refsection> -</refentry> diff --git a/2.3-1/help/en_US/AVRReadADC.xml b/2.3-1/help/en_US/AVRReadADC.xml deleted file mode 100644 index abdcad9a..00000000 --- a/2.3-1/help/en_US/AVRReadADC.xml +++ /dev/null @@ -1,71 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> - -<!-- - * - * This help file was generated from AVRReadADC.sci using help_from_sci(). - * - --> - -<refentry version="5.0-subset Scilab" xml:id="AVRReadADC" xml:lang="en" - xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:svg="http://www.w3.org/2000/svg" - xmlns:ns3="http://www.w3.org/1999/xhtml" - xmlns:mml="http://www.w3.org/1998/Math/MathML" - xmlns:scilab="http://www.scilab.org" - xmlns:db="http://docbook.org/ns/docbook"> - - <refnamediv> - <refname>AVRReadADC</refname> - <refpurpose>Function to get voltage on analog pin on AVR</refpurpose> - </refnamediv> - - -<refsynopsisdiv> - <title>Calling Sequence</title> - <synopsis> - u8AVRReadADCs(channel) - - </synopsis> -</refsynopsisdiv> - -<refsection> - <title>Parameters</title> - <variablelist> - <varlistentry><term>channel :</term> - <listitem><para> Select which channel is to be read. Values from 0-7 select one of the pins ADC0-ADC7. For other possible channel values refer datasheet</para></listitem></varlistentry> - </variablelist> -</refsection> - -<refsection> - <title>Description</title> - <para> -This function returns digital value for present on adc pins. 'channel' -selects which of the ADC0-ADC7 is to be used for reading analog value. -Apart from reading just ADC0-ADC7 other it can also read differential -voltages between some pins. For channel values for those options, please -refer datasheet. - </para> - <para> -This is curretly dummy function. It provides no functionality but is required -for providing support for generating C code for AVR. - </para> - <para> -</para> -</refsection> - -<refsection> - <title>Examples</title> - <programlisting role="example"><![CDATA[ -adc_result = u8AVRReadADC(0) //Read ADC0 - ]]></programlisting> -</refsection> - -<refsection> - <title>Authors</title> - <simplelist type="vert"> - <member>Siddhesh Wani</member> - <member>Ashish Kamble</member> - </simplelist> -</refsection> -</refentry> diff --git a/2.3-1/help/en_US/AVRSleep.xml b/2.3-1/help/en_US/AVRSleep.xml deleted file mode 100644 index 3ece53b8..00000000 --- a/2.3-1/help/en_US/AVRSleep.xml +++ /dev/null @@ -1,56 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> - -<!-- - * - * This help file was generated from AVRSleep.sci using help_from_sci(). - * - --> - -<refentry version="5.0-subset Scilab" xml:id="AVRSleep" xml:lang="en" - xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:svg="http://www.w3.org/2000/svg" - xmlns:ns3="http://www.w3.org/1999/xhtml" - xmlns:mml="http://www.w3.org/1998/Math/MathML" - xmlns:scilab="http://www.scilab.org" - xmlns:db="http://docbook.org/ns/docbook"> - - <refnamediv> - <refname>AVRSleep</refname> - <refpurpose>Function to pause the execution for the given time.</refpurpose> - </refnamediv> - - -<refsection> - <title>Description</title> - <para> -This function causes the execution to stop for the given amount of time. - </para> - <para> -This is curretly dummy function. It provides no functionality but is required -for providing support for generating C code for AVR. - </para> - <para> -</para> -</refsection> - -<refsection> - <title>Examples</title> - <programlisting role="example"><![CDATA[ -AVRSleep(5000); - ]]></programlisting> -</refsection> - -<refsection> - <title>See also</title> - <simplelist type="inline"> - </simplelist> -</refsection> - -<refsection> - <title>Authors</title> - <simplelist type="vert"> - <member>Jorawar Singh</member> - </simplelist> -</refsection> -</refentry> diff --git a/2.3-1/help/en_US/AVRTimerSetup.xml b/2.3-1/help/en_US/AVRTimerSetup.xml deleted file mode 100644 index 420e6767..00000000 --- a/2.3-1/help/en_US/AVRTimerSetup.xml +++ /dev/null @@ -1,37 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> - -<!-- - * - * This help file was generated from AVRTimerSetup.sci using help_from_sci(). - * - --> - -<refentry version="5.0-subset Scilab" xml:id="AVRTimerSetup" xml:lang="en" - xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:svg="http://www.w3.org/2000/svg" - xmlns:ns3="http://www.w3.org/1999/xhtml" - xmlns:mml="http://www.w3.org/1998/Math/MathML" - xmlns:scilab="http://www.scilab.org" - xmlns:db="http://docbook.org/ns/docbook"> - - <refnamediv> - <refname>AVRTimerSetup</refname> - <refpurpose>Function to setup Timers in ATmega16</refpurpose> - </refnamediv> - - -<refsection> - <title>See also</title> - <simplelist type="inline"> - <member><link linkend="AVRGetTimerValues">AVRGetTimerValues</link></member> - </simplelist> -</refsection> - -<refsection> - <title>Authors</title> - <simplelist type="vert"> - <member>Ashish Kamble</member> - </simplelist> -</refsection> -</refentry> diff --git a/2.3-1/help/en_US/AVRUARTReceive.xml b/2.3-1/help/en_US/AVRUARTReceive.xml deleted file mode 100644 index 84f9510e..00000000 --- a/2.3-1/help/en_US/AVRUARTReceive.xml +++ /dev/null @@ -1,59 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> - -<!-- - * - * This help file was generated from AVRUARTReceive.sci using help_from_sci(). - * - --> - -<refentry version="5.0-subset Scilab" xml:id="AVRUARTReceive" xml:lang="en" - xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:svg="http://www.w3.org/2000/svg" - xmlns:ns3="http://www.w3.org/1999/xhtml" - xmlns:mml="http://www.w3.org/1998/Math/MathML" - xmlns:scilab="http://www.scilab.org" - xmlns:db="http://docbook.org/ns/docbook"> - - <refnamediv> - <refname>AVRUARTReceive</refname> - <refpurpose>Function to Receive Char value send to ATmega16 using UART or USART.</refpurpose> - </refnamediv> - - -<refsection> - <title>Description</title> - <para> -This function Receives Char as 8 bit value.This value is stored in UDR at receiving -end. - </para> - <para> -This is curretly dummy function. It provides no functionality but is required -for providing support for generating C code for AVR. - </para> - <para> -</para> -</refsection> - -<refsection> - <title>Examples</title> - <programlisting role="example"><![CDATA[ -state = AVRUARTReceive(); //This function will Receive char and return the entire value - ]]></programlisting> -</refsection> - -<refsection> - <title>See also</title> - <simplelist type="inline"> - <member><link linkend="AVRUARTSetup">AVRUARTSetup</link></member> - <member><link linkend="AVRUARTTransmit">AVRUARTTransmit</link></member> - </simplelist> -</refsection> - -<refsection> - <title>Authors</title> - <simplelist type="vert"> - <member>Ashish Kamble</member> - </simplelist> -</refsection> -</refentry> diff --git a/2.3-1/help/en_US/AVRUARTSetup.xml b/2.3-1/help/en_US/AVRUARTSetup.xml deleted file mode 100644 index 043e2652..00000000 --- a/2.3-1/help/en_US/AVRUARTSetup.xml +++ /dev/null @@ -1,90 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> - -<!-- - * - * This help file was generated from AVRUARTSetup.sci using help_from_sci(). - * - --> - -<refentry version="5.0-subset Scilab" xml:id="AVRUARTSetup" xml:lang="en" - xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:svg="http://www.w3.org/2000/svg" - xmlns:ns3="http://www.w3.org/1999/xhtml" - xmlns:mml="http://www.w3.org/1998/Math/MathML" - xmlns:scilab="http://www.scilab.org" - xmlns:db="http://docbook.org/ns/docbook"> - - <refnamediv> - <refname>AVRUARTSetup</refname> - <refpurpose>Function to Setup Serial Communication i.e UART or USART in ATmega16.</refpurpose> - </refnamediv> - - -<refsection> - <title>Parameters</title> - <variablelist> - <varlistentry><term>mode :</term> - <listitem><para> integer, from 0 to 2</para></listitem></varlistentry> - <varlistentry><term>baudrate :</term> - <listitem><para> Enter one of the following available baudrates (2400 , 4800 , 9600 , 14400 , 19200 , 28800 , 38400 , 57600 , 768000 , 115200 , 230400 , 250000 , 1000000)</para></listitem></varlistentry> - <varlistentry><term>stopbits :</term> - <listitem><para> integer, (0 for one stopbit) or (1 for two stopbits)</para></listitem></varlistentry> - <varlistentry><term>parity :</term> - <listitem><para> integer, from 0 to 2</para></listitem></varlistentry> - </variablelist> -</refsection> - -<refsection> - <title>Description</title> - <para> -This function Setup the UART or USART for Serial Communicaion between ATmega16 -and different micro controllers or between ATmega16 and Computer. - </para> - <para> -mode can take values: -<itemizedlist> -<listitem><para>0 for Asynchronous Normal mode</para></listitem> -<listitem><para>1 for Asynchronous Double Speed mode</para></listitem> -<listitem><para>2 for Synchronous mode</para></listitem> -</itemizedlist> - </para> - <para> -parity can take values: -<itemizedlist> -<listitem><para>0 for parity disabled</para></listitem> -<listitem><para>1 for even parity</para></listitem> -<listitem><para>2 for odd parity</para></listitem> -</itemizedlist> - </para> - <para> -This is curretly dummy function. It provides no functionality but is required -for providing support for generating C code for AVR. - </para> - <para> -</para> -</refsection> - -<refsection> - <title>Examples</title> - <programlisting role="example"><![CDATA[ -AVRUARTSetup(0,9600,0,0); //This function will enable UART Communication for ATmega16 -with 9600 as baudrate,one stop bit and parity disabled - ]]></programlisting> -</refsection> - -<refsection> - <title>See also</title> - <simplelist type="inline"> - <member><link linkend="AVRUARTTransmit">AVRUARTTransmit</link></member> - <member><link linkend="AVRUARTReceive">AVRUARTReceive</link></member> - </simplelist> -</refsection> - -<refsection> - <title>Authors</title> - <simplelist type="vert"> - <member>Ashish Kamble</member> - </simplelist> -</refsection> -</refentry> diff --git a/2.3-1/help/en_US/AVRUARTTransmit.xml b/2.3-1/help/en_US/AVRUARTTransmit.xml deleted file mode 100644 index e30e374b..00000000 --- a/2.3-1/help/en_US/AVRUARTTransmit.xml +++ /dev/null @@ -1,59 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> - -<!-- - * - * This help file was generated from AVRUARTTransmit.sci using help_from_sci(). - * - --> - -<refentry version="5.0-subset Scilab" xml:id="AVRUARTTransmit" xml:lang="en" - xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:svg="http://www.w3.org/2000/svg" - xmlns:ns3="http://www.w3.org/1999/xhtml" - xmlns:mml="http://www.w3.org/1998/Math/MathML" - xmlns:scilab="http://www.scilab.org" - xmlns:db="http://docbook.org/ns/docbook"> - - <refnamediv> - <refname>AVRUARTTransmit</refname> - <refpurpose>Function to Transmit data using UART or USART.</refpurpose> - </refnamediv> - - -<refsection> - <title>Description</title> - <para> -This function Tranmits data over UART or USART.The data to be transmitted can -be a Char , String , Unsigned Int, Signed Int. - </para> - <para> -This is curretly dummy function. It provides no functionality but is required -for providing support for generating C code for AVR. - </para> - <para> -</para> -</refsection> - -<refsection> - <title>Examples</title> - <programlisting role="example"><![CDATA[ -AVRUARTTransmit("This is example"); //This function will transmit the entered string. - ]]></programlisting> -</refsection> - -<refsection> - <title>See also</title> - <simplelist type="inline"> - <member><link linkend="AVRUARTSetup">AVRUARTSetup</link></member> - <member><link linkend="AVRUARTReceive">AVRUARTReceive</link></member> - </simplelist> -</refsection> - -<refsection> - <title>Authors</title> - <simplelist type="vert"> - <member>Ashish Kamble</member> - </simplelist> -</refsection> -</refentry> diff --git a/2.3-1/help/en_US/CV_AdaptiveThreshold.xml b/2.3-1/help/en_US/CV_AdaptiveThreshold.xml deleted file mode 100644 index 1483442a..00000000 --- a/2.3-1/help/en_US/CV_AdaptiveThreshold.xml +++ /dev/null @@ -1,86 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> - -<!-- - * - * This help file was generated from CV_AdaptiveThreshold.sci using help_from_sci(). - * - --> - -<refentry version="5.0-subset Scilab" xml:id="CV_AdaptiveThreshold" xml:lang="en" - xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:svg="http://www.w3.org/2000/svg" - xmlns:ns3="http://www.w3.org/1999/xhtml" - xmlns:mml="http://www.w3.org/1998/Math/MathML" - xmlns:scilab="http://www.scilab.org" - xmlns:db="http://docbook.org/ns/docbook"> - - <refnamediv> - <refname>CV_AdaptiveThreshold</refname> - <refpurpose>function to adaptively threshold input image</refpurpose> - </refnamediv> - - -<refsynopsisdiv> - <title>Calling Sequence</title> - <synopsis> - dst = CV_AdaptiveThreshold(srcimg,max_value,adaptive_method,thresh_type,blk_size,c) - - </synopsis> -</refsynopsisdiv> - -<refsection> - <title>Parameters</title> - <variablelist> - <varlistentry><term>src :</term> - <listitem><para> Source 8-bit single-channel image.</para></listitem></varlistentry> - <varlistentry><term>max_value :</term> - <listitem><para> Non-zero value assigned to the pixels for which the condition is satisfied. See the details below.</para></listitem></varlistentry> - <varlistentry><term>adaptive_method :</term> - <listitem><para> Adaptive thresholding algorithm to use, ADAPTIVE_THRESH_MEAN_C or ADAPTIVE_THRESH_GAUSSIAN_C .</para></listitem></varlistentry> - <varlistentry><term>thresh_type :</term> - <listitem><para> Thresholding type that must be either THRESH_BINARY or THRESH_BINARY_INV .</para></listitem></varlistentry> - <varlistentry><term>blockSize :</term> - <listitem><para> Size of a pixel neighborhood that is used to calculate a threshold value for the pixel: 3, 5, 7, and so on.</para></listitem></varlistentry> - <varlistentry><term>C :</term> - <listitem><para> Constant subtracted from the mean or weighted mean.Normally, it is positive but may be zero or negative as well.</para></listitem></varlistentry> - </variablelist> -</refsection> - -<refsection> - <title>Description</title> - <para> -This function can be used for adaptively threshold given image - </para> - <para> -This is curretly dummy function. It provides no functionality but is required -for providing support for generating C code for OpenCV - </para> - <para> -</para> -</refsection> - -<refsection> - <title>Examples</title> - <programlisting role="example"><![CDATA[ -img = CV_LoadImage('~/test.jpg',0) -dst = CV_AdaptiveThreshold(img,255,"ADAPTIVE_THRESH_MEAN_C", ... -"THRESH_BINARY",5,0) - - ]]></programlisting> -</refsection> - -<refsection> - <title>See also</title> - <simplelist type="inline"> - <member><link linkend="CV_LoadImage">CV_CreateImage</link></member> - </simplelist> -</refsection> - -<refsection> - <title>Authors</title> - <simplelist type="vert"> - <member>Siddhesh Wani</member> - </simplelist> -</refsection> -</refentry> diff --git a/2.3-1/help/en_US/CV_Blur.xml b/2.3-1/help/en_US/CV_Blur.xml deleted file mode 100644 index 228b3107..00000000 --- a/2.3-1/help/en_US/CV_Blur.xml +++ /dev/null @@ -1,92 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> - -<!-- - * - * This help file was generated from CV_Blur.sci using help_from_sci(). - * - --> - -<refentry version="5.0-subset Scilab" xml:id="CV_Blur" xml:lang="en" - xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:svg="http://www.w3.org/2000/svg" - xmlns:ns3="http://www.w3.org/1999/xhtml" - xmlns:mml="http://www.w3.org/1998/Math/MathML" - xmlns:scilab="http://www.scilab.org" - xmlns:db="http://docbook.org/ns/docbook"> - - <refnamediv> - <refname>CV_Blur</refname> - <refpurpose>function to blur image using normalised box filter</refpurpose> - </refnamediv> - - -<refsynopsisdiv> - <title>Calling Sequence</title> - <synopsis> - dst = CV_Blur(srcimg,ksize_width,ksize_height,anchor_x,anchor_y,border_type) - - </synopsis> -</refsynopsisdiv> - -<refsection> - <title>Parameters</title> - <variablelist> - <varlistentry><term>srcimg :</term> - <listitem><para> Source image.</para></listitem></varlistentry> - <varlistentry><term>ksize_width, ksize_height :</term> - <listitem><para> blurring kernel size.</para></listitem></varlistentry> - <varlistentry><term>anchor_x, anchor_y :</term> - <listitem><para> x,y coordinates of anchor point</para></listitem></varlistentry> - <varlistentry><term>border_type :</term> - <listitem><para> border mode used to extrapolate pixels outside of the image.</para></listitem></varlistentry> - </variablelist> -</refsection> - -<refsection> - <title>Description</title> - <para> -This function can be used for blurring image using normalised box -filter. Image can be of any depth and have any no of channels. - </para> - <para> -border_type can be : -<itemizedlist> -<listitem>BORDER_REPLICATE: aaaaaa|abcdefgh|hhhhhhh</listitem> -<listitem>BORDER_REFLECT: fedcba|abcdefgh|hgfedcb</listitem> -<listitem>BORDER_REFLECT_101: gfedcb|abcdefgh|gfedcba</listitem> -<listitem>BORDER_WRAP: cdefgh|abcdefgh|abcdefg</listitem> -<listitem>BORDER_CONSTANT: iiiiii|abcdefgh|iiiiiii</listitem> -</itemizedlist> - </para> - <para> -This is curretly dummy function. It provides no functionality but is required -for providing support for generating C code for OpenCV - </para> - <para> -</para> -</refsection> - -<refsection> - <title>Examples</title> - <programlisting role="example"><![CDATA[ -img = CV_LoadImage('~/test.jpg',0) -dst = CV_Blur(img,3,3,-1,-1,"BORDER_CONSTANT") - - ]]></programlisting> -</refsection> - -<refsection> - <title>See also</title> - <simplelist type="inline"> - <member><link linkend="CV_LoadImage">CV_Threshold, CV_CvtColor</link></member> - </simplelist> -</refsection> - -<refsection> - <title>Authors</title> - <simplelist type="vert"> - <member>Siddhesh Wani</member> - </simplelist> -</refsection> -</refentry> diff --git a/2.3-1/help/en_US/CV_Canny.xml b/2.3-1/help/en_US/CV_Canny.xml deleted file mode 100644 index daf7f55b..00000000 --- a/2.3-1/help/en_US/CV_Canny.xml +++ /dev/null @@ -1,88 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> - -<!-- - * - * This help file was generated from CV_Canny.sci using help_from_sci(). - * - --> - -<refentry version="5.0-subset Scilab" xml:id="CV_Canny" xml:lang="en" - xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:svg="http://www.w3.org/2000/svg" - xmlns:ns3="http://www.w3.org/1999/xhtml" - xmlns:mml="http://www.w3.org/1998/Math/MathML" - xmlns:scilab="http://www.scilab.org" - xmlns:db="http://docbook.org/ns/docbook"> - - <refnamediv> - <refname>CV_Canny</refname> - <refpurpose>Finds edges in image using Canny algorithm</refpurpose> - </refnamediv> - - -<refsynopsisdiv> - <title>Calling Sequence</title> - <synopsis> - edges = CV_Canny(srcimg,threhold1,threshold2,aperture_size,L2gradient) - - </synopsis> -</refsynopsisdiv> - -<refsection> - <title>Parameters</title> - <variablelist> - <varlistentry><term>srcimg :</term> - <listitem><para> single-channel 8-bit input image.</para></listitem></varlistentry> - <varlistentry><term>threshold1 :</term> - <listitem><para> first threshold for the hysteresis procedure.</para></listitem></varlistentry> - <varlistentry><term>threshold2 :</term> - <listitem><para> second threshold for the hysteresis procedure.</para></listitem></varlistentry> - <varlistentry><term>aperture_size :</term> - <listitem><para> aperture size for the Sobel() operator.</para></listitem></varlistentry> - <varlistentry><term>L2gradient :</term> - <listitem><para> a flag, indicating whether a more accurate</para></listitem></varlistentry> - </variablelist> -</refsection> - -<refsection> - <title>Description</title> - <para> -This function can be used for finding edes in single channel 8 bit -image. 'aperture_size' and 'L2gradient' are optionals. By default, -aperture_size is 3 and L2gradient is false. - </para> - <para> -For L2gradient: L_2 norm =sqrt{(dI/dx)^2 + (dI/dy)^2} should be used to calculate the image gradient magnitude (L2gradient=1 ), or whether the default L_1 norm =|dI/dx|+|dI/dy| is enough (L2gradient=0). - </para> - <para> -This is curretly dummy function. It provides no functionality but is required -for providing support for generating C code for OpenCV - </para> - <para> -</para> -</refsection> - -<refsection> - <title>Examples</title> - <programlisting role="example"><![CDATA[ -img = CV_LoadImage('~/test.jpg',0) -dst = CV_CvtColor(img,"CV_RGB2GRAY"); -edge = CV_Canny(dst,50,100,3,0); - ]]></programlisting> -</refsection> - -<refsection> - <title>See also</title> - <simplelist type="inline"> - <member><link linkend="CV_LoadImage">CV_CvtColor</link></member> - </simplelist> -</refsection> - -<refsection> - <title>Authors</title> - <simplelist type="vert"> - <member>Siddhesh Wani</member> - </simplelist> -</refsection> -</refentry> diff --git a/2.3-1/help/en_US/CV_CornerHarris.xml b/2.3-1/help/en_US/CV_CornerHarris.xml deleted file mode 100644 index e9b94260..00000000 --- a/2.3-1/help/en_US/CV_CornerHarris.xml +++ /dev/null @@ -1,93 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> - -<!-- - * - * This help file was generated from CV_CornerHarris.sci using help_from_sci(). - * - --> - -<refentry version="5.0-subset Scilab" xml:id="CV_CornerHarris" xml:lang="en" - xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:svg="http://www.w3.org/2000/svg" - xmlns:ns3="http://www.w3.org/1999/xhtml" - xmlns:mml="http://www.w3.org/1998/Math/MathML" - xmlns:scilab="http://www.scilab.org" - xmlns:db="http://docbook.org/ns/docbook"> - - <refnamediv> - <refname>CV_CornerHarris</refname> - <refpurpose>Finds edges in image using Harris algorithm</refpurpose> - </refnamediv> - - -<refsynopsisdiv> - <title>Calling Sequence</title> - <synopsis> - edges = CV_CornerHarris(srcimg,blocksize,ksize,k,border_type) - - </synopsis> -</refsynopsisdiv> - -<refsection> - <title>Parameters</title> - <variablelist> - <varlistentry><term>srcimg:</term> - <listitem><para> Input single-channel 8-bit or floating-point image.</para></listitem></varlistentry> - <varlistentry><term>blockSize:</term> - <listitem><para> Neighborhood size</para></listitem></varlistentry> - <varlistentry><term>ksize:</term> - <listitem><para> Aperture parameter for the Sobel() operator.</para></listitem></varlistentry> - <varlistentry><term>k:</term> - <listitem><para> Harris detector free parameter.</para></listitem></varlistentry> - <varlistentry><term>border_type:</term> - <listitem><para> border mode used to extrapolate pixels outside of the image.</para></listitem></varlistentry> - </variablelist> -</refsection> - -<refsection> - <title>Description</title> - <para> -The function runs the Harris edge detector on the image. For each pixel (x, y) it calculates a 2 * 2 gradient covariance matrix M(x,y) over a blockSize * blockSize neighborhood. Then, it computes the following characteristic: dst(x,y) = det(M(x,y)) - k .tr(M(x,y))^2. Corners in the image can be found as the local maxima of this response map. - </para> - <para> -border_type can be : -<itemizedlist> -<listitem>BORDER_REPLICATE: aaaaaa|abcdefgh|hhhhhhh</listitem> -<listitem>BORDER_REFLECT: fedcba|abcdefgh|hgfedcb</listitem> -<listitem>BORDER_REFLECT_101: gfedcb|abcdefgh|gfedcba</listitem> -<listitem>BORDER_WRAP: cdefgh|abcdefgh|abcdefg</listitem> -<listitem>BORDER_CONSTANT: iiiiii|abcdefgh|iiiiiii</listitem> -</itemizedlist> - </para> - <para> -This is curretly dummy function. It provides no functionality but is required -for providing support for generating C code for OpenCV - </para> - <para> -</para> -</refsection> - -<refsection> - <title>Examples</title> - <programlisting role="example"><![CDATA[ -img = CV_LoadImage('~/test.jpg',0) -dst = CV_CvtColor(img,"CV_RGB2GRAY"); -edge = CV_CornerHarris(dst,5,3,1,"BORDER_REPLICATE"); - ]]></programlisting> -</refsection> - -<refsection> - <title>See also</title> - <simplelist type="inline"> - <member><link linkend="CV_LoadImage">CV_CvtColor</link></member> - </simplelist> -</refsection> - -<refsection> - <title>Authors</title> - <simplelist type="vert"> - <member>Siddhesh Wani</member> - </simplelist> -</refsection> -</refentry> diff --git a/2.3-1/help/en_US/CV_CreateImage.xml b/2.3-1/help/en_US/CV_CreateImage.xml deleted file mode 100644 index 45fde568..00000000 --- a/2.3-1/help/en_US/CV_CreateImage.xml +++ /dev/null @@ -1,76 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> - -<!-- - * - * This help file was generated from CV_CreateImage.sci using help_from_sci(). - * - --> - -<refentry version="5.0-subset Scilab" xml:id="CV_CreateImage" xml:lang="en" - xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:svg="http://www.w3.org/2000/svg" - xmlns:ns3="http://www.w3.org/1999/xhtml" - xmlns:mml="http://www.w3.org/1998/Math/MathML" - xmlns:scilab="http://www.scilab.org" - xmlns:db="http://docbook.org/ns/docbook"> - - <refnamediv> - <refname>CV_CreateImage</refname> - <refpurpose>function to create an image object of given size and type</refpurpose> - </refnamediv> - - -<refsynopsisdiv> - <title>Calling Sequence</title> - <synopsis> - CV_CreateImage(image_size,bit_depth,no_of_channels) - - </synopsis> -</refsynopsisdiv> - -<refsection> - <title>Parameters</title> - <variablelist> - <varlistentry><term>image_size:</term> - <listitem><para> width and height of image</para></listitem></varlistentry> - <varlistentry><term>bit_depth:</term> - <listitem><para> Bit depth of image elements</para></listitem></varlistentry> - <varlistentry><term>no_of_channels:</term> - <listitem><para> no of channels per pixels</para></listitem></varlistentry> - </variablelist> -</refsection> - -<refsection> - <title>Description</title> - <para> -This function can be used to create opencv image object. For more info about bit depth and channels,please refer to OpenCV documentation - </para> - <para> -This is curretly dummy function. It provides no functionality but is required for providing support for generating C code for OpenCV - </para> - <para> -</para> -</refsection> - -<refsection> - <title>Examples</title> - <programlisting role="example"><![CDATA[ -CV_CreateImage([320 240], "IPL_DEPTH_8U", 1) //to create image of the size 320*240 pixels with 8 bit unsigned each pixels and gray scale image - ]]></programlisting> -</refsection> - -<refsection> - <title>See also</title> - <simplelist type="inline"> - <member><link linkend="CV_LoadImage">CV_LoadImage</link></member> - </simplelist> -</refsection> - -<refsection> - <title>Authors</title> - <simplelist type="vert"> - <member>Siddhesh Wani</member> - </simplelist> -</refsection> -</refentry> diff --git a/2.3-1/help/en_US/CV_CvtColor.xml b/2.3-1/help/en_US/CV_CvtColor.xml deleted file mode 100644 index f1f25e0e..00000000 --- a/2.3-1/help/en_US/CV_CvtColor.xml +++ /dev/null @@ -1,81 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> - -<!-- - * - * This help file was generated from CV_CvtColor.sci using help_from_sci(). - * - --> - -<refentry version="5.0-subset Scilab" xml:id="CV_CvtColor" xml:lang="en" - xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:svg="http://www.w3.org/2000/svg" - xmlns:ns3="http://www.w3.org/1999/xhtml" - xmlns:mml="http://www.w3.org/1998/Math/MathML" - xmlns:scilab="http://www.scilab.org" - xmlns:db="http://docbook.org/ns/docbook"> - - <refnamediv> - <refname>CV_CvtColor</refname> - <refpurpose>function to convert image from one colorspace to other colorspace</refpurpose> - </refnamediv> - - -<refsynopsisdiv> - <title>Calling Sequence</title> - <synopsis> - CV_CvtColor(srcimg,code) - - </synopsis> -</refsynopsisdiv> - -<refsection> - <title>Parameters</title> - <variablelist> - <varlistentry><term>srcimg:</term> - <listitem><para> source image to be converted</para></listitem></varlistentry> - <varlistentry><term>dstimg:</term> - <listitem><para> destination image in which to store converted image</para></listitem></varlistentry> - <varlistentry><term>code:</term> - <listitem><para> String specifying conversion type. Same as defined in OpenCV. for eg. 'CV_RGB2GRAY' for conversion from RGB image to grayscale image</para></listitem></varlistentry> - <varlistentry><term>dstCn:</term> - <listitem><para> no of channels in destination image (0 by default)</para></listitem></varlistentry> - </variablelist> -</refsection> - -<refsection> - <title>Description</title> - <para> -This function can be used for converting an image to other colorspace. -Refer OpenCV documentation for list of available conversions - </para> - <para> -This is curretly dummy function. It provides no functionality but is required -for providing support for generating C code for OpenCV - </para> - <para> -</para> -</refsection> - -<refsection> - <title>Examples</title> - <programlisting role="example"><![CDATA[ -img = CV_LoadImage('~/test.jpg',0) -dst = CV_CvtColor(img,'CV_RGB2GRAY') - ]]></programlisting> -</refsection> - -<refsection> - <title>See also</title> - <simplelist type="inline"> - <member><link linkend="CV_LoadImage">CV_CreateImage</link></member> - </simplelist> -</refsection> - -<refsection> - <title>Authors</title> - <simplelist type="vert"> - <member>Siddhesh Wani</member> - </simplelist> -</refsection> -</refentry> diff --git a/2.3-1/help/en_US/CV_Dilate.xml b/2.3-1/help/en_US/CV_Dilate.xml deleted file mode 100644 index d01b3ab7..00000000 --- a/2.3-1/help/en_US/CV_Dilate.xml +++ /dev/null @@ -1,93 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> - -<!-- - * - * This help file was generated from CV_Dilate.sci using help_from_sci(). - * - --> - -<refentry version="5.0-subset Scilab" xml:id="CV_Dilate" xml:lang="en" - xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:svg="http://www.w3.org/2000/svg" - xmlns:ns3="http://www.w3.org/1999/xhtml" - xmlns:mml="http://www.w3.org/1998/Math/MathML" - xmlns:scilab="http://www.scilab.org" - xmlns:db="http://docbook.org/ns/docbook"> - - <refnamediv> - <refname>CV_Dilate</refname> - <refpurpose>dilates an image by using a specific structuring element.</refpurpose> - </refnamediv> - - -<refsynopsisdiv> - <title>Calling Sequence</title> - <synopsis> - cvtimg = CV_Dilate(srcimg,dilation_type,dilation_size,[iterations,border_type,border_value]) - </synopsis> -</refsynopsisdiv> - -<refsection> - <title>Parameters</title> - <variablelist> - <varlistentry><term>src :</term> - <listitem><para> input image; the number of channels can be arbitrary, but the depth should be one of CV_8U, CV_16U, CV_16S, CV_32F or CV_64F.</para></listitem></varlistentry> - <varlistentry><term>dilation_type :</term> - <listitem><para> can be one of MORPH_RECT, MORPH_CROSS,MORPH_ELLIPSE</para></listitem></varlistentry> - <varlistentry><term>dilation_size :</term> - <listitem><para> size of kernel to be used for erosion. Must be odd</para></listitem></varlistentry> - <varlistentry><term>iterations :</term> - <listitem><para> number of times erosion is applied.</para></listitem></varlistentry> - <varlistentry><term>border_type :</term> - <listitem><para> pixel extrapolation method.</para></listitem></varlistentry> - <varlistentry><term>border_value :</term> - <listitem><para> border value in case of a constant border</para></listitem></varlistentry> - </variablelist> -</refsection> - -<refsection> - <title>Description</title> - <para> -This function can be used for eroding an image. Kernel used for erosion is decided by type and size. Size must always be odd. Anchor pint of kernel is always center of kernel. Input arguements 'iterations(1), border_type(BORDER_CONSTANT) and border_value' are optionals. Whwn not specified, default values as as mentioned in brackets. - </para> - <para> -border_type can be : -<itemizedlist> -<listitem><para> BORDER_REPLICATE: aaaaaa|abcdefgh|hhhhhhh </para></listitem> -<listitem><para> BORDER_REFLECT: fedcba|abcdefgh|hgfedcb </para></listitem> -<listitem><para> BORDER_REFLECT_101: gfedcb|abcdefgh|gfedcba </para></listitem> -<listitem><para> BORDER_WRAP: cdefgh|abcdefgh|abcdefg </para></listitem> -<listitem><para> BORDER_CONSTANT: iiiiii|abcdefgh|iiiiiii </para></listitem> -</itemizedlist> - </para> - <para> -This is curretly dummy function. It provides no functionality but is required -for providing support for generating C code for OpenCV - </para> - <para> -</para> -</refsection> - -<refsection> - <title>Examples</title> - <programlisting role="example"><![CDATA[ -img = CV_LoadImage('~/test.jpg',0) -dst = CV_Erode(img,"MORPH_RECT",3,1,"BORDER_CONSTANT",0); - ]]></programlisting> -</refsection> - -<refsection> - <title>See also</title> - <simplelist type="inline"> - <member><link linkend="CV_LoadImage">CV_Erode</link></member> - </simplelist> -</refsection> - -<refsection> - <title>Authors</title> - <simplelist type="vert"> - <member>Siddhesh Wani</member> - </simplelist> -</refsection> -</refentry> diff --git a/2.3-1/help/en_US/CV_DistanceTransform.xml b/2.3-1/help/en_US/CV_DistanceTransform.xml deleted file mode 100644 index 07929993..00000000 --- a/2.3-1/help/en_US/CV_DistanceTransform.xml +++ /dev/null @@ -1,78 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> - -<!-- - * - * This help file was generated from CV_DistanceTransform.sci using help_from_sci(). - * - --> - -<refentry version="5.0-subset Scilab" xml:id="CV_DistanceTransform" xml:lang="en" - xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:svg="http://www.w3.org/2000/svg" - xmlns:ns3="http://www.w3.org/1999/xhtml" - xmlns:mml="http://www.w3.org/1998/Math/MathML" - xmlns:scilab="http://www.scilab.org" - xmlns:db="http://docbook.org/ns/docbook"> - - <refnamediv> - <refname>CV_DistanceTransform</refname> - <refpurpose>function to calculate distance to closest zero pixels for each pixel</refpurpose> - </refnamediv> - - -<refsynopsisdiv> - <title>Calling Sequence</title> - <synopsis> - dst = CV_DistanceTransform(srcimg,distance_type,mask_size) - - </synopsis> -</refsynopsisdiv> - -<refsection> - <title>Parameters</title> - <variablelist> - <varlistentry><term>srcimg :</term> - <listitem><para> Source 8-bit single-channel image.</para></listitem></varlistentry> - <varlistentry><term>distance_type :</term> - <listitem><para> Type of distance. It can be CV_DIST_L1, CV_DIST_L2 , or CV_DIST_C</para></listitem></varlistentry> - <varlistentry><term>mask_size :</term> - <listitem><para> Size of the distance transform mask</para></listitem></varlistentry> - </variablelist> -</refsection> - -<refsection> - <title>Description</title> - <para> -This function can be used to calculate distance to closest zero pixel for each pixel of the source image. Output is 32 bit floatingpoint, single channel image of the same size as that of source image. - </para> - <para> -This is curretly dummy function. It provides no functionality but is required -for providing support for generating C code for OpenCV - </para> - <para> -</para> -</refsection> - -<refsection> - <title>Examples</title> - <programlisting role="example"><![CDATA[ -img = CV_LoadImage('~/test.jpg',0) -dst = CV_DistanceTransform(img,"CV_DIST_L1",3) - ]]></programlisting> -</refsection> - -<refsection> - <title>See also</title> - <simplelist type="inline"> - <member><link linkend="CV_LoadImage">CV_CreateImage CV_CvtColor</link></member> - </simplelist> -</refsection> - -<refsection> - <title>Authors</title> - <simplelist type="vert"> - <member>Siddhesh Wani</member> - </simplelist> -</refsection> -</refentry> diff --git a/2.3-1/help/en_US/CV_Erode.xml b/2.3-1/help/en_US/CV_Erode.xml deleted file mode 100644 index 103d4899..00000000 --- a/2.3-1/help/en_US/CV_Erode.xml +++ /dev/null @@ -1,93 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> - -<!-- - * - * This help file was generated from CV_Erode.sci using help_from_sci(). - * - --> - -<refentry version="5.0-subset Scilab" xml:id="CV_Erode" xml:lang="en" - xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:svg="http://www.w3.org/2000/svg" - xmlns:ns3="http://www.w3.org/1999/xhtml" - xmlns:mml="http://www.w3.org/1998/Math/MathML" - xmlns:scilab="http://www.scilab.org" - xmlns:db="http://docbook.org/ns/docbook"> - - <refnamediv> - <refname>CV_Erode</refname> - <refpurpose>Erodes an image by using a specific structuring element.</refpurpose> - </refnamediv> - - -<refsynopsisdiv> - <title>Calling Sequence</title> - <synopsis> - cvtimg = CV_Erode(srcimg,erosion_type,erosion_size,[iterations,border_type,border_value]) - </synopsis> -</refsynopsisdiv> - -<refsection> - <title>Parameters</title> - <variablelist> - <varlistentry><term>src :</term> - <listitem><para> input image; the number of channels can be arbitrary, but the depth should be one of CV_8U, CV_16U, CV_16S, CV_32F or CV_64F.</para></listitem></varlistentry> - <varlistentry><term>erosion_type :</term> - <listitem><para> can be one of : MORPH_RECT, MORPH_CROSS, MORPH_ELLIPSE</para></listitem></varlistentry> - <varlistentry><term>erosion_size :</term> - <listitem><para> size of kernel to be used for erosion. Must be odd</para></listitem></varlistentry> - <varlistentry><term>iterations :</term> - <listitem><para> number of times erosion is applied.</para></listitem></varlistentry> - <varlistentry><term>border_type :</term> - <listitem><para> pixel extrapolation method.</para></listitem></varlistentry> - <varlistentry><term>border_value :</term> - <listitem><para> border value in case of a constant border</para></listitem></varlistentry> - </variablelist> -</refsection> - -<refsection> - <title>Description</title> - <para> -This function can be used for eroding an image. Kernel used for erosion is decided by type and size. Size must always be odd. Anchor pint of kernel is always center of kernel. Input arguements 'iterations(1), border_type(BORDER_CONSTANT) and border_value' are optionals. Whwn not specified, default values as as mentioned in brackets. - </para> - <para> -border_type can be : -<itemizedlist> -<listitem>BORDER_REPLICATE: aaaaaa|abcdefgh|hhhhhhh</listitem> -<listitem>BORDER_REFLECT: fedcba|abcdefgh|hgfedcb</listitem> -<listitem>BORDER_REFLECT_101: gfedcb|abcdefgh|gfedcba</listitem> -<listitem>BORDER_WRAP: cdefgh|abcdefgh|abcdefg</listitem> -<listitem>BORDER_CONSTANT: iiiiii|abcdefgh|iiiiiii</listitem> -</itemizedlist> - </para> - <para> -This is curretly dummy function. It provides no functionality but is required -for providing support for generating C code for OpenCV - </para> - <para> -</para> -</refsection> - -<refsection> - <title>Examples</title> - <programlisting role="example"><![CDATA[ -img = CV_LoadImage('~/test.jpg',0) -dst = CV_Erode(img,"MORPH_RECT",3,1,"BORDER_CONSTANT",0); - ]]></programlisting> -</refsection> - -<refsection> - <title>See also</title> - <simplelist type="inline"> - <member><link linkend="CV_LoadImage">CV_Dilate</link></member> - </simplelist> -</refsection> - -<refsection> - <title>Authors</title> - <simplelist type="vert"> - <member>Siddhesh Wani</member> - </simplelist> -</refsection> -</refentry> diff --git a/2.3-1/help/en_US/CV_GaussianBlur.xml b/2.3-1/help/en_US/CV_GaussianBlur.xml deleted file mode 100644 index 88a8f33c..00000000 --- a/2.3-1/help/en_US/CV_GaussianBlur.xml +++ /dev/null @@ -1,95 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> - -<!-- - * - * This help file was generated from CV_GaussianBlur.sci using help_from_sci(). - * - --> - -<refentry version="5.0-subset Scilab" xml:id="CV_GaussianBlur" xml:lang="en" - xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:svg="http://www.w3.org/2000/svg" - xmlns:ns3="http://www.w3.org/1999/xhtml" - xmlns:mml="http://www.w3.org/1998/Math/MathML" - xmlns:scilab="http://www.scilab.org" - xmlns:db="http://docbook.org/ns/docbook"> - - <refnamediv> - <refname>CV_GaussianBlur</refname> - <refpurpose>function to blur image using gaussian filter</refpurpose> - </refnamediv> - - -<refsynopsisdiv> - <title>Calling Sequence</title> - <synopsis> - cvtimg = CV_GaussianBlur(srcimg,ksize_width,ksize_height,sigma_x,sigma_y,border_type) - - </synopsis> -</refsynopsisdiv> - -<refsection> - <title>Parameters</title> - <variablelist> - <varlistentry><term>srcimg :</term> - <listitem><para> Source image.</para></listitem></varlistentry> - <varlistentry><term>ksize_width, ksize_height :</term> - <listitem><para> blurring kernel size. must be odd.</para></listitem></varlistentry> - <varlistentry><term>sigmaX :</term> - <listitem><para> Gaussian kernel standard deviation in X direction.</para></listitem></varlistentry> - <varlistentry><term>sigmaY :</term> - <listitem><para> Gaussian kernel standard deviation in Y direction;</para></listitem></varlistentry> - <varlistentry><term>border_type :</term> - <listitem><para> border mode used to extrapolate pixels outside of the image.</para></listitem></varlistentry> - </variablelist> -</refsection> - -<refsection> - <title>Description</title> - <para> -This function can be used for blurring image using gaussian filter. Image can be of any depth and have any no of channels. - </para> - <para> -For sigmaX and sigmaY : if sigmaY is zero, it is set to be equal to sigmaX, if both sigmas are zeros, they are computed from ksize.width and ksize.height , respectively. - </para> - <para> -border_type can be : -<itemizedlist> -<listitem>BORDER_REPLICATE: aaaaaa|abcdefgh|hhhhhhh</listitem> -<listitem>BORDER_REFLECT: fedcba|abcdefgh|hgfedcb</listitem> -<listitem>BORDER_REFLECT_101: gfedcb|abcdefgh|gfedcba</listitem> -<listitem>BORDER_WRAP: cdefgh|abcdefgh|abcdefg</listitem> -<listitem>BORDER_CONSTANT: iiiiii|abcdefgh|iiiiiii</listitem> -</itemizedlist> - </para> - <para> -This is curretly dummy function. It provides no functionality but is required -for providing support for generating C code for OpenCV - </para> - <para> -</para> -</refsection> - -<refsection> - <title>Examples</title> - <programlisting role="example"><![CDATA[ -img = CV_LoadImage('~/test.jpg',0) -dst = CV_GaussianBlur(img,3,3,0,0,"BORDER_CONSTANT") - ]]></programlisting> -</refsection> - -<refsection> - <title>See also</title> - <simplelist type="inline"> - <member><link linkend="CV_LoadImage">CV_Blur, CV_CvtColor</link></member> - </simplelist> -</refsection> - -<refsection> - <title>Authors</title> - <simplelist type="vert"> - <member>Siddhesh Wani</member> - </simplelist> -</refsection> -</refentry> diff --git a/2.3-1/help/en_US/CV_GetImgSize.xml b/2.3-1/help/en_US/CV_GetImgSize.xml deleted file mode 100644 index 717c8086..00000000 --- a/2.3-1/help/en_US/CV_GetImgSize.xml +++ /dev/null @@ -1,75 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> - -<!-- - * - * This help file was generated from CV_GetImgSize.sci using help_from_sci(). - * - --> - -<refentry version="5.0-subset Scilab" xml:id="CV_GetImgSize" xml:lang="en" - xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:svg="http://www.w3.org/2000/svg" - xmlns:ns3="http://www.w3.org/1999/xhtml" - xmlns:mml="http://www.w3.org/1998/Math/MathML" - xmlns:scilab="http://www.scilab.org" - xmlns:db="http://docbook.org/ns/docbook"> - - <refnamediv> - <refname>CV_GetImgSize</refname> - <refpurpose>function to get size of the image (width*height)</refpurpose> - </refnamediv> - - -<refsynopsisdiv> - <title>Calling Sequence</title> - <synopsis> - CV_GetImgSize(img) - - </synopsis> -</refsynopsisdiv> - -<refsection> - <title>Parameters</title> - <variablelist> - <varlistentry><term>img:</term> - <listitem><para> image whose size is to be returned</para></listitem></varlistentry> - </variablelist> -</refsection> - -<refsection> - <title>Description</title> - <para> -This function can be used for retriving size information of the image. -It returs an array with first image element as width and second as height - </para> - <para> -This is curretly dummy function. It provides no functionality but is required -for providing support for generating C code for OpenCV - </para> - <para> -</para> -</refsection> - -<refsection> - <title>Examples</title> - <programlisting role="example"><![CDATA[ -img = CV_LoadImage('~/test.jpg',0) -size = CV_GetImgSize(img) - ]]></programlisting> -</refsection> - -<refsection> - <title>See also</title> - <simplelist type="inline"> - <member><link linkend="CV_LoadImage">CV_CreateImage</link></member> - </simplelist> -</refsection> - -<refsection> - <title>Authors</title> - <simplelist type="vert"> - <member>Siddhesh Wani</member> - </simplelist> -</refsection> -</refentry> diff --git a/2.3-1/help/en_US/CV_LoadImage.xml b/2.3-1/help/en_US/CV_LoadImage.xml deleted file mode 100644 index 70f55c82..00000000 --- a/2.3-1/help/en_US/CV_LoadImage.xml +++ /dev/null @@ -1,83 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> - -<!-- - * - * This help file was generated from CV_LoadImage.sci using help_from_sci(). - * - --> - -<refentry version="5.0-subset Scilab" xml:id="CV_LoadImage" xml:lang="en" - xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:svg="http://www.w3.org/2000/svg" - xmlns:ns3="http://www.w3.org/1999/xhtml" - xmlns:mml="http://www.w3.org/1998/Math/MathML" - xmlns:scilab="http://www.scilab.org" - xmlns:db="http://docbook.org/ns/docbook"> - - <refnamediv> - <refname>CV_LoadImage</refname> - <refpurpose>function to load an image object from given filename</refpurpose> - </refnamediv> - - -<refsynopsisdiv> - <title>Calling Sequence</title> - <synopsis> - CV_LoadImage(filename,loadtype) - - </synopsis> -</refsynopsisdiv> - -<refsection> - <title>Parameters</title> - <variablelist> - <varlistentry><term>filename:</term> - <listitem><para> name of file to be opened</para></listitem></varlistentry> - <varlistentry><term>loadtype:</term> - <listitem><para> desired load method</para></listitem></varlistentry> - </variablelist> -</refsection> - -<refsection> - <title>Description</title> - <para> -This function can be used for loading a previously stored image - </para> - <para> -loadtype can take the following values: -<itemizedlist> -<listitem><para> less than 0 -> image is loaded as is (with alpha channel)</para></listitem> -<listitem><para> 0 -> image is loaded as greyscale</para></listitem> -<listitem><para> greater than 0 -> 3 channel color image is loaded</para></listitem> -</itemizedlist> - </para> - <para> -This is curretly dummy function. It provides no functionality but is required -for providing support for generating C code for OpenCV - </para> - <para> -</para> -</refsection> - -<refsection> - <title>Examples</title> - <programlisting role="example"><![CDATA[ -CV_LoadImage('~/test.jpg',0) - ]]></programlisting> -</refsection> - -<refsection> - <title>See also</title> - <simplelist type="inline"> - <member><link linkend="CV_CreateImage">CV_CreateImage</link></member> - </simplelist> -</refsection> - -<refsection> - <title>Authors</title> - <simplelist type="vert"> - <member>Siddhesh Wani</member> - </simplelist> -</refsection> -</refentry> diff --git a/2.3-1/help/en_US/CV_MedianBlur.xml b/2.3-1/help/en_US/CV_MedianBlur.xml deleted file mode 100644 index d10291ca..00000000 --- a/2.3-1/help/en_US/CV_MedianBlur.xml +++ /dev/null @@ -1,77 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> - -<!-- - * - * This help file was generated from CV_MedianBlur.sci using help_from_sci(). - * - --> - -<refentry version="5.0-subset Scilab" xml:id="CV_MedianBlur" xml:lang="en" - xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:svg="http://www.w3.org/2000/svg" - xmlns:ns3="http://www.w3.org/1999/xhtml" - xmlns:mml="http://www.w3.org/1998/Math/MathML" - xmlns:scilab="http://www.scilab.org" - xmlns:db="http://docbook.org/ns/docbook"> - - <refnamediv> - <refname>CV_MedianBlur</refname> - <refpurpose>function to blur image using median filter</refpurpose> - </refnamediv> - - -<refsynopsisdiv> - <title>Calling Sequence</title> - <synopsis> - cvtimg = CV_MedianBlur(srcimg,ksize) - - </synopsis> -</refsynopsisdiv> - -<refsection> - <title>Parameters</title> - <variablelist> - <varlistentry><term>srcimg :</term> - <listitem><para> input 1-, 3-, or 4-channel image; when ksize is 3 or 5, the image depth should be CV_8U, CV_16U, or CV_32F, for larger aperture sizes, it can only be CV_8U.</para></listitem></varlistentry> - <varlistentry><term>ksize_width :</term> - <listitem><para> aperture linear size; it must be odd and greater than 1, for example: 3, 5, 7 ...</para></listitem></varlistentry> - </variablelist> -</refsection> - -<refsection> - <title>Description</title> - <para> -This function can be used for blurring image using median -filter. Image can be of any depth and have any no of channels. - </para> - <para> -This is curretly dummy function. It provides no functionality but is required -for providing support for generating C code for OpenCV - </para> - <para> -</para> -</refsection> - -<refsection> - <title>Examples</title> - <programlisting role="example"><![CDATA[ -img = CV_LoadImage('~/test.jpg',0) -dst = CV_MedianBlur(img,3) - ]]></programlisting> -</refsection> - -<refsection> - <title>See also</title> - <simplelist type="inline"> - <member><link linkend="CV_GaussianBlur,">CV_Blur, CV_CvtColor</link></member> - </simplelist> -</refsection> - -<refsection> - <title>Authors</title> - <simplelist type="vert"> - <member>Siddhesh Wani</member> - </simplelist> -</refsection> -</refentry> diff --git a/2.3-1/help/en_US/CV_SaveImage.xml b/2.3-1/help/en_US/CV_SaveImage.xml deleted file mode 100644 index 9e73200f..00000000 --- a/2.3-1/help/en_US/CV_SaveImage.xml +++ /dev/null @@ -1,77 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> - -<!-- - * - * This help file was generated from CV_SaveImage.sci using help_from_sci(). - * - --> - -<refentry version="5.0-subset Scilab" xml:id="CV_SaveImage" xml:lang="en" - xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:svg="http://www.w3.org/2000/svg" - xmlns:ns3="http://www.w3.org/1999/xhtml" - xmlns:mml="http://www.w3.org/1998/Math/MathML" - xmlns:scilab="http://www.scilab.org" - xmlns:db="http://docbook.org/ns/docbook"> - - <refnamediv> - <refname>CV_SaveImage</refname> - <refpurpose>function to save an image object as a given filename</refpurpose> - </refnamediv> - - -<refsynopsisdiv> - <title>Calling Sequence</title> - <synopsis> - CV_SaveImage(filename,img) - - </synopsis> -</refsynopsisdiv> - -<refsection> - <title>Parameters</title> - <variablelist> - <varlistentry><term>filename:</term> - <listitem><para> name of file image to be saved as</para></listitem></varlistentry> - <varlistentry><term>img:</term> - <listitem><para> image to be saved</para></listitem></varlistentry> - </variablelist> -</refsection> - -<refsection> - <title>Description</title> - <para> -This function can be used for saving image. File format is detected -from file extension - </para> - <para> -This is curretly dummy function. It provides no functionality but is required -for providing support for generating C code for OpenCV - </para> - <para> -</para> -</refsection> - -<refsection> - <title>Examples</title> - <programlisting role="example"><![CDATA[ -img = CV_LoadImage('~/test.jpg',0) -CV_SaveImage('test1.png',img) - ]]></programlisting> -</refsection> - -<refsection> - <title>See also</title> - <simplelist type="inline"> - <member><link linkend="CV_LoadImage">CV_CreateImage</link></member> - </simplelist> -</refsection> - -<refsection> - <title>Authors</title> - <simplelist type="vert"> - <member>Siddhesh Wani</member> - </simplelist> -</refsection> -</refentry> diff --git a/2.3-1/help/en_US/CV_ShowImage.xml b/2.3-1/help/en_US/CV_ShowImage.xml deleted file mode 100644 index e3f6e674..00000000 --- a/2.3-1/help/en_US/CV_ShowImage.xml +++ /dev/null @@ -1,77 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> - -<!-- - * - * This help file was generated from CV_ShowImage.sci using help_from_sci(). - * - --> - -<refentry version="5.0-subset Scilab" xml:id="CV_ShowImage" xml:lang="en" - xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:svg="http://www.w3.org/2000/svg" - xmlns:ns3="http://www.w3.org/1999/xhtml" - xmlns:mml="http://www.w3.org/1998/Math/MathML" - xmlns:scilab="http://www.scilab.org" - xmlns:db="http://docbook.org/ns/docbook"> - - <refnamediv> - <refname>CV_ShowImage</refname> - <refpurpose>function to show an image</refpurpose> - </refnamediv> - - -<refsynopsisdiv> - <title>Calling Sequence</title> - <synopsis> - CV_ShowImage(img) - CV_ShowImage(winname,img) - - </synopsis> -</refsynopsisdiv> - -<refsection> - <title>Parameters</title> - <variablelist> - <varlistentry><term>winname:</term> - <listitem><para> name of window in which img is to be shown</para></listitem></varlistentry> - <varlistentry><term>img:</term> - <listitem><para> image to be shown already acquired (from file/camera)</para></listitem></varlistentry> - </variablelist> -</refsection> - -<refsection> - <title>Description</title> - <para> -This function can be used for showing images - </para> - <para> -This is curretly dummy function. It provides no functionality but is required -for providing support for generating C code for OpenCV - </para> - <para> -</para> -</refsection> - -<refsection> - <title>Examples</title> - <programlisting role="example"><![CDATA[ -img = CV_LoadImage('~/test.jpg',0) -CV_ShowImage(img) - ]]></programlisting> -</refsection> - -<refsection> - <title>See also</title> - <simplelist type="inline"> - <member><link linkend="CV_CreateImage">CV_LoadImage</link></member> - </simplelist> -</refsection> - -<refsection> - <title>Authors</title> - <simplelist type="vert"> - <member>Siddhesh Wani</member> - </simplelist> -</refsection> -</refentry> diff --git a/2.3-1/help/en_US/CV_Threshold.xml b/2.3-1/help/en_US/CV_Threshold.xml deleted file mode 100644 index 0de0c145..00000000 --- a/2.3-1/help/en_US/CV_Threshold.xml +++ /dev/null @@ -1,81 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> - -<!-- - * - * This help file was generated from CV_Threshold.sci using help_from_sci(). - * - --> - -<refentry version="5.0-subset Scilab" xml:id="CV_Threshold" xml:lang="en" - xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:svg="http://www.w3.org/2000/svg" - xmlns:ns3="http://www.w3.org/1999/xhtml" - xmlns:mml="http://www.w3.org/1998/Math/MathML" - xmlns:scilab="http://www.scilab.org" - xmlns:db="http://docbook.org/ns/docbook"> - - <refnamediv> - <refname>CV_Threshold</refname> - <refpurpose>function to threshold input image</refpurpose> - </refnamediv> - - -<refsynopsisdiv> - <title>Calling Sequence</title> - <synopsis> - dst = CV_Threshold(srcimg,code,threshold,max_value,thresh_type) - - </synopsis> -</refsynopsisdiv> - -<refsection> - <title>Parameters</title> - <variablelist> - <varlistentry><term>srcimg:</term> - <listitem><para> source image to be converted</para></listitem></varlistentry> - <varlistentry><term>threshold:</term> - <listitem><para> threshold value</para></listitem></varlistentry> - <varlistentry><term>max_value:</term> - <listitem><para> maximum value to be used with THRESH_BINARY and THRESH_BINARY_INV</para></listitem></varlistentry> - <varlistentry><term>thresh_type:</term> - <listitem><para> Type for threshold. It can one of the following: THRESH_BINARY, THRESH_BINARY_INV, THRESH_TRUNC, THRESH_TOZERO, THRESH_TOZERO_INV</para></listitem></varlistentry> - </variablelist> -</refsection> - -<refsection> - <title>Description</title> - <para> -This function can be used for converting an image to other colorspace. -Refer OpenCV documentation for list of available conversions - </para> - <para> -This is curretly dummy function. It provides no functionality but is required -for providing support for generating C code for OpenCV - </para> - <para> -</para> -</refsection> - -<refsection> - <title>Examples</title> - <programlisting role="example"><![CDATA[ -img = CV_LoadImage('~/test.jpg',0) -dst = CV_Threshold(img,100,255,'THRESH_BINARY') - ]]></programlisting> -</refsection> - -<refsection> - <title>See also</title> - <simplelist type="inline"> - <member><link linkend="CV_LoadImage">CV_CreateImage</link></member> - </simplelist> -</refsection> - -<refsection> - <title>Authors</title> - <simplelist type="vert"> - <member>Siddhesh Wani</member> - </simplelist> -</refsection> -</refentry> diff --git a/2.3-1/help/en_US/CV_WaitKey.xml b/2.3-1/help/en_US/CV_WaitKey.xml deleted file mode 100644 index 9b527077..00000000 --- a/2.3-1/help/en_US/CV_WaitKey.xml +++ /dev/null @@ -1,76 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> - -<!-- - * - * This help file was generated from CV_WaitKey.sci using help_from_sci(). - * - --> - -<refentry version="5.0-subset Scilab" xml:id="CV_WaitKey" xml:lang="en" - xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:svg="http://www.w3.org/2000/svg" - xmlns:ns3="http://www.w3.org/1999/xhtml" - xmlns:mml="http://www.w3.org/1998/Math/MathML" - xmlns:scilab="http://www.scilab.org" - xmlns:db="http://docbook.org/ns/docbook"> - - <refnamediv> - <refname>CV_WaitKey</refname> - <refpurpose>function similar to cvWaitKey</refpurpose> - </refnamediv> - - -<refsynopsisdiv> - <title>Calling Sequence</title> - <synopsis> - CV_WaitKey(delay) - - </synopsis> -</refsynopsisdiv> - -<refsection> - <title>Parameters</title> - <variablelist> - <varlistentry><term>delay:</term> - <listitem><para> waiting delay, if 0 then wait till keypress</para></listitem></varlistentry> - </variablelist> -</refsection> - -<refsection> - <title>Description</title> - <para> -This function can be used for inseting some delay. This function must -follow CV_ShowImage to display image. - </para> - <para> -This is curretly dummy function. It provides no functionality but is required -for providing support for generating C code for OpenCV - </para> - <para> -</para> -</refsection> - -<refsection> - <title>Examples</title> - <programlisting role="example"><![CDATA[ -img = CV_LoadImage('~/test.jpg',0) -CV_ShowImage('',img) -CV_WaitKey(0); - ]]></programlisting> -</refsection> - -<refsection> - <title>See also</title> - <simplelist type="inline"> - <member><link linkend="CV_LoadImage">CV_ShowImage</link></member> - </simplelist> -</refsection> - -<refsection> - <title>Authors</title> - <simplelist type="vert"> - <member>Siddhesh Wani</member> - </simplelist> -</refsection> -</refentry> diff --git a/2.3-1/help/en_US/scilab_en_US_help/jhelpidx.xml b/2.3-1/help/en_US/scilab_en_US_help/jhelpidx.xml deleted file mode 100644 index aa5a66e2..00000000 --- a/2.3-1/help/en_US/scilab_en_US_help/jhelpidx.xml +++ /dev/null @@ -1,3 +0,0 @@ -<?xml version="1.0" encoding="utf-8" standalone="no"?> -<!DOCTYPE index PUBLIC "-//Sun Microsystems Inc.//DTD JavaHelp Index Version 1.0//EN" "http://java.sun.com/products/javahelp/index_1_0.dtd"> -<index version="1.0"/>
\ No newline at end of file diff --git a/2.3-1/help/en_US/scilab_en_US_help/jhelpmap.jhm b/2.3-1/help/en_US/scilab_en_US_help/jhelpmap.jhm index f4fd3177..a97448b6 100644 --- a/2.3-1/help/en_US/scilab_en_US_help/jhelpmap.jhm +++ b/2.3-1/help/en_US/scilab_en_US_help/jhelpmap.jhm @@ -2,7 +2,11 @@ <!DOCTYPE map PUBLIC "-//Sun Microsystems Inc.//DTD JavaHelp Map Version 1.0//EN" "http://java.sun.com/products/javahelp/map_1_0.dtd"> <map version="1.0"> <mapID target="index" url="index.html"/> +<<<<<<< HEAD <mapID target="section_009504e67ab100d6991ada9db2f321bb" url="section_009504e67ab100d6991ada9db2f321bb.html"/> +======= +<mapID target="section_35ee3b19a97c75b084122c05ac0777c6" url="section_35ee3b19a97c75b084122c05ac0777c6.html"/> +>>>>>>> 8106d4ce6960cfd63c3a42171fdf5d52e46ccb06 <mapID target="AVRADCSetup" url="AVRADCSetup.html"/> <mapID target="AVRDigitalIn" url="AVRDigitalIn.html"/> <mapID target="AVRDigitalOut" url="AVRDigitalOut.html"/> |