Skip to content

Commit 07e3405

Browse files
committed
Update small ROI documentation
1 parent 200b505 commit 07e3405

File tree

5 files changed

+158
-24
lines changed

5 files changed

+158
-24
lines changed

doc/SelectBigROI.md

Lines changed: 158 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -15,21 +15,28 @@ These commands are responsible for selecting "big" regions of interest. By "big"
1515
- [Case three: Vertical Description](#case-three-vertical-description)
1616
- [Case four: Vertical Block And Nth Adjective](#case-four-vertical-block-and-nth-adjective)
1717
- [Selectable](#selectable)
18-
- [Assignment And Expression Statements](#assignment-and-expression-statements)
19-
- [If conditions While loops With clauses](#if-conditions-while-loops-with-clauses)
20-
- [If expressions](#if-expressions)
21-
- [Return Value](#return-value)
22-
- [Iterator and Iterable](#iterator-and-iterable)
23-
- [Comprehensions](#comprehensions)
24-
- [Exception Handling](#exception-handling)
25-
- [Assertions And Exceptions Raising](#assertions-and-exceptions-raising)
26-
- [Functional Definitions](#functional-definitions)
27-
- [Class Definitions](#class-definitions)
28-
- [Import](#import)
29-
- [Lambda](#lambda)
30-
- [Continue Break Pass](#continue-break-pass)
31-
- [Experimental Same](#experimental-same)
32-
- [Temporary Until Small Regions](#temporary-until-small-regions)
18+
- [Assignment And Expression Statements](#assignment-and-expression-statements)
19+
- [If conditions While loops With clauses](#if-conditions-while-loops-with-clauses)
20+
- [If expressions](#if-expressions)
21+
- [Return Value](#return-value)
22+
- [Iterator and Iterable](#iterator-and-iterable)
23+
- [Comprehensions](#comprehensions)
24+
- [Exception Handling](#exception-handling)
25+
- [Assertions And Exceptions Raising](#assertions-and-exceptions-raising)
26+
- [Functional Definitions](#functional-definitions)
27+
- [Class Definitions](#class-definitions)
28+
- [Import](#import)
29+
- [Lambda](#lambda)
30+
- [Continue Break Pass](#continue-break-pass)
31+
- [Experimental Same](#experimental-same)
32+
- [Temporary Until Small Regions](#temporary-until-small-regions)
33+
- [Disclaimer](#disclaimer)
34+
- [Literals](#literals)
35+
- [Subscripts and Attribute](#subscripts-and-attribute)
36+
- [Comparisons Arithmetical And Boolean Operations](#comparisons-arithmetical-and-boolean-operations)
37+
- [More On Comparisons](#more-on-comparisons)
38+
- [More On Boolean](#more-on-boolean)
39+
- [More On Arithmetic](#more-on-arithmetic)
3340

3441
<!-- /MarkdownTOC -->
3542

@@ -459,24 +466,151 @@ what is the core idea? when you use `same`, the queries going to behave as if th
459466

460467
### Temporary Until Small Regions
461468

469+
#### Disclaimer
470+
462471
What follows has a nearly one hundred percent chance of getting removed in the future :)
463472

464-
One of the weaknesses of the 0.1.0 release is that it does not include support for small regions via dedicated commands so in order to extract them, currently you need to use sub indexing. This of course is not always satisfying and in certain cases can even be very annoying (for instance when editing json file). As a temporary solution so that you have something to get by until release 0.2.0 introduces small regions of interest properly , the following regions have been added as Big Roi
473+
One of the weaknesses of the 0.1.0 release is that it does not include support for small regions via dedicated commands so in order to extract them, currently you need to use sub indexing. This of course is not always satisfying and in certain cases can even be very annoying (for instance when editing json file). As a temporary solution so that you have something to get by until release 0.2.0 introduces small regions of interest properly , various regions have been added as Big Roi
474+
475+
A few very important things to note
476+
477+
- The way they work with nth adjectives might feel even more clumsy than usual, but this is only temporary.
478+
479+
- The search in the way the ordinal adjectives are decoded is function wide!
480+
481+
-
482+
483+
484+
485+
486+
```python
487+
"string" : "string",
488+
"integer literal" : "integer literal",
489+
"dictionary" : "dictionary",
490+
"list" : "list",
491+
"tuple" : "tuple",
492+
"set" : "set",
493+
494+
495+
"subscript" : "subscript",
496+
"subscript body" : "subscript body",
497+
"key" : "key",
498+
"lower" : "lower",
499+
"upper" : "upper",
500+
"step" : "step",
501+
502+
"attribute" : "attribute",
503+
504+
"comparison" : "comparison",
505+
"arithmetic" : "arithmetic",
506+
"boolean" : "boolean",
507+
508+
"member": "member",
509+
"container": "container",
510+
"membership" : "membership",
511+
512+
"left side" : "left side",
513+
"right side" : "right side",
514+
"middle" : "middle",
515+
516+
"arithmetic left" : "arithmetic left" ,
517+
"arithmetic right" : "arithmetic right",
518+
"arithmetic middle" : "arithmetic middle",
519+
520+
"boolean left" : "boolean left",
521+
"boolean right" : "boolean right",
522+
"boolean middle" : "boolean middle",
523+
524+
"boolean and" : "boolean and" ,
525+
"boolean or" : "boolean or",
526+
527+
```
528+
529+
530+
in the following we are going to quickly go through these regions but not in great detail because they are either way immature, highly likely subject to future change, they lack for the time being there dedicated commands and there are technicalities with some of them! But I hope you get the main idea
531+
532+
#### Literals
533+
534+
![](./gif/big39.gif)
535+
536+
537+
```python
538+
"string" : "string",
539+
"integer literal" : "integer literal",
540+
"dictionary" : "dictionary",
541+
"list" : "list",
542+
"tuple" : "tuple",
543+
"set" : "set",
544+
```
545+
546+
547+
#### Subscripts and Attribute
548+
549+
![](./gif/big40.gif)
550+
551+
```python
552+
"attribute" : "attribute",
553+
554+
"subscript" : "subscript",
555+
"subscript body" : "subscript body",
556+
"key" : "key",
557+
"lower" : "lower",
558+
"upper" : "upper",
559+
"step" : "step"
560+
```
561+
562+
#### Comparisons Arithmetical And Boolean Operations
563+
564+
![](./gif/big41.gif)
565+
566+
```python
567+
"comparison" : "comparison",
568+
"arithmetic" : "arithmetic",
569+
"boolean" : "boolean",
570+
```
571+
572+
#### More On Comparisons
573+
574+
![](./gif/big42.gif)
575+
576+
```python
577+
"member": "member",
578+
"container": "container",
579+
"membership" : "membership",
580+
581+
"left side" : "left side",
582+
"right side" : "right side",
583+
"middle" : "middle",
584+
```
585+
586+
#### More On Boolean
587+
588+
589+
![](./gif/big43.gif)
465590

466591

467592
```python
468-
# "string" : "string",
469-
# "integer literal" : "integer literal",
470-
# "dictionary" : "dictionary",
471-
# "list" : "list",
472-
# "tuple" : "tuple",
473-
# "set" : "set",
474-
# "key" : "key",
593+
"boolean left" : "boolean left",
594+
"boolean right" : "boolean right",
595+
"boolean middle" : "boolean middle",
596+
597+
"boolean and" : "boolean and" ,
598+
"boolean or" : "boolean or",
475599
```
476600

601+
#### More On Arithmetic
602+
603+
![](./gif/big44.gif)
604+
605+
```python
606+
"arithmetic left" : "arithmetic left" ,
607+
"arithmetic right" : "arithmetic right",
608+
"arithmetic middle" : "arithmetic middle",
609+
```
610+
611+
477612

478613

479-
The way they work with nth adjectives might feel even more clumsy than usual, but this is only temporary.
480614

481615

482616

doc/gif/big39.gif

344 KB
Loading

doc/gif/big41.gif

359 KB
Loading

doc/gif/big42.gif

404 KB
Loading

doc/gif/big44.gif

239 KB
Loading

0 commit comments

Comments
 (0)