Commit ec082fc6 authored by Thomas Chauve's avatar Thomas Chauve
Browse files

fix title

parent ba271144
Pipeline #72543 passed with stage
in 10 seconds
......@@ -7,8 +7,8 @@ Loading data
:special-members:
:members:
Functions
*********
aita xr.Dataset accessor
************************
.. automodule:: xarrayaita.aita
:special-members:
:members:
......@@ -6,9 +6,9 @@
Welcome to xarray_aita's documentation!
=======================================
``xarray_aita`` is a `xarray <http://xarray.pydata.org/en/stable/>`_ accesors to work on orientation map such as the one obtained using AITA.
``xarray_aita`` is a `xarray <http://xarray.pydata.org/en/stable/>`_ accessors to work on orientation map such as the one obtained using AITA.
In this documentation detail of the functions are given. For quick start script to use this accesors we recommend the `AITA Book <https://mecaiceige.gricad-pages.univ-grenoble-alpes.fr/tools/documentations/AITA-book/docs/intro.html>`_
In this documentation detail of the functions are given. For quick start script to use this accessors we recommend the `AITA Book <https://mecaiceige.gricad-pages.univ-grenoble-alpes.fr/tools/documentations/AITA-book/docs/intro.html>`_
.. toctree::
:maxdepth: 2
......
......@@ -87,7 +87,7 @@
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">1. Functions overview</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#module-xarrayaita.loadData_aita">1.1. Loading data</a></li>
<li class="toctree-l2"><a class="reference internal" href="#module-xarrayaita.aita">1.2. Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="#module-xarrayaita.aita">1.2. aita xr.Dataset accessor</a></li>
</ul>
</li>
</ul>
......@@ -206,7 +206,7 @@
</div>
<div class="section" id="module-xarrayaita.aita">
<span id="functions"></span><h2><span class="section-number">1.2. </span>Functions<a class="headerlink" href="#module-xarrayaita.aita" title="Permalink to this headline"></a></h2>
<span id="aita-xr-dataset-accessor"></span><h2><span class="section-number">1.2. </span>aita xr.Dataset accessor<a class="headerlink" href="#module-xarrayaita.aita" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="xarrayaita.aita.aita">
<em class="property">class </em><code class="sig-prename descclassname">xarrayaita.aita.</code><code class="sig-name descname">aita</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">xarray_obj</span></em><span class="sig-paren">)</span><a class="headerlink" href="#xarrayaita.aita.aita" title="Permalink to this definition"></a></dt>
......
......@@ -155,8 +155,8 @@
<div class="section" id="welcome-to-xarray-aita-s-documentation">
<h1>Welcome to xarray_aita’s documentation!<a class="headerlink" href="#welcome-to-xarray-aita-s-documentation" title="Permalink to this headline"></a></h1>
<p><code class="docutils literal notranslate"><span class="pre">xarray_aita</span></code> is a <a class="reference external" href="http://xarray.pydata.org/en/stable/">xarray</a> accesors to work on orientation map such as the one obtained using AITA.</p>
<p>In this documentation detail of the functions are given. For quick start script to use this accesors we recommend the <a class="reference external" href="https://mecaiceige.gricad-pages.univ-grenoble-alpes.fr/tools/documentations/AITA-book/docs/intro.html">AITA Book</a></p>
<p><code class="docutils literal notranslate"><span class="pre">xarray_aita</span></code> is a <a class="reference external" href="http://xarray.pydata.org/en/stable/">xarray</a> accessors to work on orientation map such as the one obtained using AITA.</p>
<p>In this documentation detail of the functions are given. For quick start script to use this accessors we recommend the <a class="reference external" href="https://mecaiceige.gricad-pages.univ-grenoble-alpes.fr/tools/documentations/AITA-book/docs/intro.html">AITA Book</a></p>
<div class="toctree-wrapper compound">
</div>
</div>
......@@ -178,7 +178,7 @@ pip install -e .
<ul>
<li class="toctree-l1"><a class="reference internal" href="func_o.html">1. Functions overview</a><ul>
<li class="toctree-l2"><a class="reference internal" href="func_o.html#module-xarrayaita.loadData_aita">1.1. Loading data</a></li>
<li class="toctree-l2"><a class="reference internal" href="func_o.html#module-xarrayaita.aita">1.2. Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="func_o.html#module-xarrayaita.aita">1.2. aita xr.Dataset accessor</a></li>
</ul>
</li>
</ul>
......
Search.setIndex({docnames:["func_o","index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["func_o.rst","index.rst"],objects:{"xarrayaita.aita":{aita:[0,1,1,""]},"xarrayaita.aita.aita":{__init__:[0,2,1,""],__weakref__:[0,3,1,""],closest_outG_value:[0,2,1,""],craft:[0,2,1,""],crop:[0,2,1,""],dist2GB:[0,2,1,""],dist2TJ:[0,2,1,""],filter:[0,2,1,""],fliplr:[0,2,1,""],interactive_crop:[0,2,1,""],interactive_misorientation_profile:[0,2,1,""],interactive_segmentation:[0,2,1,""],mean_grain:[0,2,1,""],plotBoundary:[0,2,1,""],resize:[0,2,1,""],rot180:[0,2,1,""],rot90c:[0,2,1,""]},"xarrayaita.loadData_aita":{aita3col:[0,4,1,""],aita5col:[0,4,1,""],craft_input:[0,4,1,""]},xarrayaita:{aita:[0,0,0,"-"],loadData_aita:[0,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","attribute","Python attribute"],"4":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:attribute","4":"py:function"},terms:{"100":0,"180":0,"class":0,"default":0,"export":0,"float":0,"function":[],"int":0,"return":0,"true":0,For:1,IGE:1,The:0,__init__:0,__weakref__:0,abs:0,accesor:1,add:0,adr_data:0,adr_phas:0,adr_vtk:0,aita3col:0,aita5col:0,aita:[0,1],allow:0,alp:1,analys:0,around:0,arrai:0,author:1,axi:0,between:0,black:0,bmp:0,book:1,bool:0,border:0,boundari:0,boundri:0,can:0,canni:0,chauv:1,clockwis:0,clone:1,closest:0,closest_outg_valu:0,column:0,compat:0,comput:0,constructor:0,contain:0,could:0,craft:0,craft_input:0,crop:0,dai:0,data:1,dataarrai:0,dataset:0,defin:0,degr:0,degre:0,detail:1,dilat:0,dim:0,direct:0,dist2gb:0,dist2tj:0,distanc:0,doc:[],doe:0,each:0,egg:[],environn:0,fals:0,few:1,file:0,filter:0,flip:0,fliplr:0,from:0,g50:0,git:1,gitlab:1,given:1,grain:0,grainid:0,grenobl:1,gricad:1,have:0,heritag:0,hole:0,html:[],http:1,imag:0,inc_border_init:0,index:1,initi:0,insid:0,interact:0,interactive_crop:0,interactive_misorientation_profil:0,interactive_segment:0,intiti:0,intro:[],jupyt:0,kwarg:0,least:0,left:0,lib_python:1,lim:0,list:0,load:1,loaddata_aita:0,m3d:0,mai:0,main:[],manag:1,map:1,mean:0,mean_grain:0,mecaiceig:1,micro:0,micro_adress:0,microstructur:0,mis2o:0,mis2p:0,misorient:0,modul:1,more:0,move:0,nameid:0,nan:0,notebook:0,object:0,obtain:1,one:[0,1],org:[],organ:1,orient:[0,1],out:0,overview:[],overwis:0,page:1,param:0,paramet:0,path:0,perform:0,phase:0,pip:1,pixel:0,plot:0,plotboundari:0,pos:0,profil:0,progress:1,put:0,pydata:[],python:1,qualiti:0,quick:1,radian:0,rebuild_gid:0,recommend:[0,1],recomput:0,refer:0,remov:0,repositori:[],requir:1,res:0,resiz:0,resolut:0,retrun:0,right:0,rot180:0,rot90c:0,rotat:0,routat:0,rtype:0,scharr:0,script:1,search:1,segmen:0,segment:0,set:0,should:0,simul:0,size:0,snow:0,stabl:[],start:1,statu:1,step:0,str:0,structur:0,support:0,symmetr:1,thi:[0,1],thoma:1,tool:1,txt:1,type:0,unit:1,univ:1,use:[0,1],use_canny_init:0,use_qua_init:0,use_scharr_init:0,using:[0,1],usual:0,uvec:0,val:0,val_canny_init:0,val_pixel:0,val_pixel_closest_grain:0,val_qua_init:0,val_scharr_init:0,valu:0,vector:1,version:1,vtk:0,weak:0,where:0,white:0,within:0,work:[0,1],xada:0,xarrai:[0,1],xarray_obj:0,xarray_uvec:1,xarrayaita:0,you:0},titles:["<span class=\"section-number\">1. </span>Functions overview","Welcome to xarray_aita\u2019s documentation!"],titleterms:{"function":[0,1],contact:1,data:0,depend:1,devellop:[],document:1,from:1,indic:1,instal:1,load:0,overview:[0,1],repositori:1,tabl:1,user:[],welcom:1,xarray_aita:1}})
\ No newline at end of file
Search.setIndex({docnames:["func_o","index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["func_o.rst","index.rst"],objects:{"xarrayaita.aita":{aita:[0,1,1,""]},"xarrayaita.aita.aita":{__init__:[0,2,1,""],__weakref__:[0,3,1,""],closest_outG_value:[0,2,1,""],craft:[0,2,1,""],crop:[0,2,1,""],dist2GB:[0,2,1,""],dist2TJ:[0,2,1,""],filter:[0,2,1,""],fliplr:[0,2,1,""],interactive_crop:[0,2,1,""],interactive_misorientation_profile:[0,2,1,""],interactive_segmentation:[0,2,1,""],mean_grain:[0,2,1,""],plotBoundary:[0,2,1,""],resize:[0,2,1,""],rot180:[0,2,1,""],rot90c:[0,2,1,""]},"xarrayaita.loadData_aita":{aita3col:[0,4,1,""],aita5col:[0,4,1,""],craft_input:[0,4,1,""]},xarrayaita:{aita:[0,0,0,"-"],loadData_aita:[0,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","attribute","Python attribute"],"4":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:attribute","4":"py:function"},terms:{"100":0,"180":0,"class":0,"default":0,"export":0,"float":0,"function":[],"int":0,"return":0,"true":0,For:1,IGE:1,The:0,__init__:0,__weakref__:0,abs:0,accesor:[],accessor:1,add:0,adr_data:0,adr_phas:0,adr_vtk:0,aita3col:0,aita5col:0,aita:1,allow:0,alp:1,analys:0,around:0,arrai:0,author:1,axi:0,between:0,black:0,bmp:0,book:1,bool:0,border:0,boundari:0,boundri:0,can:0,canni:0,chauv:1,clockwis:0,clone:1,closest:0,closest_outg_valu:0,column:0,compat:0,comput:0,constructor:0,contain:0,could:0,craft:0,craft_input:0,crop:0,dai:0,data:1,dataarrai:0,dataset:1,defin:0,degr:0,degre:0,detail:1,dilat:0,dim:0,direct:0,dist2gb:0,dist2tj:0,distanc:0,doc:[],doe:0,each:0,egg:[],environn:0,fals:0,few:1,file:0,filter:0,flip:0,fliplr:0,from:0,g50:0,git:1,gitlab:1,given:1,grain:0,grainid:0,grenobl:1,gricad:1,have:0,heritag:0,hole:0,html:[],http:1,imag:0,inc_border_init:0,index:1,initi:0,insid:0,interact:0,interactive_crop:0,interactive_misorientation_profil:0,interactive_segment:0,intiti:0,intro:[],jupyt:0,kwarg:0,least:0,left:0,lib_python:1,lim:0,list:0,load:1,loaddata_aita:0,m3d:0,mai:0,main:[],manag:1,map:1,mean:0,mean_grain:0,mecaiceig:1,micro:0,micro_adress:0,microstructur:0,mis2o:0,mis2p:0,misorient:0,modul:1,more:0,move:0,nameid:0,nan:0,notebook:0,object:0,obtain:1,one:[0,1],org:[],organ:1,orient:[0,1],out:0,overview:[],overwis:0,page:1,param:0,paramet:0,path:0,perform:0,phase:0,pip:1,pixel:0,plot:0,plotboundari:0,pos:0,profil:0,progress:1,put:0,pydata:[],python:1,qualiti:0,quick:1,radian:0,rebuild_gid:0,recommend:[0,1],recomput:0,refer:0,remov:0,repositori:[],requir:1,res:0,resiz:0,resolut:0,retrun:0,right:0,rot180:0,rot90c:0,rotat:0,routat:0,rtype:0,scharr:0,script:1,search:1,segmen:0,segment:0,set:0,should:0,simul:0,size:0,snow:0,stabl:[],start:1,statu:1,step:0,str:0,structur:0,support:0,symmetr:1,thi:[0,1],thoma:1,tool:1,txt:1,type:0,unit:1,univ:1,use:[0,1],use_canny_init:0,use_qua_init:0,use_scharr_init:0,using:[0,1],usual:0,uvec:0,val:0,val_canny_init:0,val_pixel:0,val_pixel_closest_grain:0,val_qua_init:0,val_scharr_init:0,valu:0,vector:1,version:1,vtk:0,weak:0,where:0,white:0,within:0,work:[0,1],xada:0,xarrai:[0,1],xarray_obj:0,xarray_uvec:1,xarrayaita:0,you:0},titles:["<span class=\"section-number\">1. </span>Functions overview","Welcome to xarray_aita\u2019s documentation!"],titleterms:{"function":[0,1],accessor:0,aita:0,contact:1,data:0,dataset:0,depend:1,devellop:[],document:1,from:1,indic:1,instal:1,load:0,overview:[0,1],repositori:1,tabl:1,user:[],welcom:1,xarray_aita:1}})
\ No newline at end of file
......@@ -7,8 +7,8 @@ Loading data
:special-members:
:members:
Functions
*********
aita xr.Dataset accessor
************************
.. automodule:: xarrayaita.aita
:special-members:
:members:
......@@ -6,9 +6,9 @@
Welcome to xarray_aita's documentation!
=======================================
``xarray_aita`` is a `xarray <http://xarray.pydata.org/en/stable/>`_ accesors to work on orientation map such as the one obtained using AITA.
``xarray_aita`` is a `xarray <http://xarray.pydata.org/en/stable/>`_ accessors to work on orientation map such as the one obtained using AITA.
In this documentation detail of the functions are given. For quick start script to use this accesors we recommend the `AITA Book <https://mecaiceige.gricad-pages.univ-grenoble-alpes.fr/tools/documentations/AITA-book/docs/intro.html>`_
In this documentation detail of the functions are given. For quick start script to use this accessors we recommend the `AITA Book <https://mecaiceige.gricad-pages.univ-grenoble-alpes.fr/tools/documentations/AITA-book/docs/intro.html>`_
.. toctree::
:maxdepth: 2
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment