├── .gitignore ├── LICENSE ├── README.md ├── pom.xml └── src └── main ├── java ├── org │ └── elephant │ │ └── cellsparse │ │ ├── AbstractCellsparseCommands.java │ │ ├── CellsparseBody.java │ │ ├── CellsparseCellposeExtension.java │ │ ├── CellsparseElephantExtension.java │ │ ├── CellsparseResetBody.java │ │ └── CellsparseStarDistExtension.java └── qupath │ └── lib │ └── images │ └── servers │ └── LabeledOffsetImageServer.java └── resources └── META-INF └── services └── qupath.lib.gui.extensions.QuPathExtension /.gitignore: -------------------------------------------------------------------------------- 1 | target/ 2 | .classpath 3 | .project 4 | 5 | ### Eclipse ### 6 | .metadata 7 | bin/ 8 | tmp/ 9 | *.tmp 10 | *.bak 11 | *.swp 12 | *~.nib 13 | local.properties 14 | .settings/ 15 | .loadpath 16 | .recommenders 17 | 18 | # External tool builders 19 | .externalToolBuilders/ 20 | 21 | # Locally stored "Eclipse launch configurations" 22 | *.launch 23 | 24 | # PyDev specific (Python IDE for Eclipse) 25 | *.pydevproject 26 | 27 | # CDT-specific (C/C++ Development Tooling) 28 | .cproject 29 | 30 | # CDT- autotools 31 | .autotools 32 | 33 | # Java annotation processor (APT) 34 | .factorypath 35 | 36 | # PDT-specific (PHP Development Tools) 37 | .buildpath 38 | 39 | # sbteclipse plugin 40 | .target 41 | 42 | # Tern plugin 43 | .tern-project 44 | 45 | # TeXlipse plugin 46 | .texlipse 47 | 48 | # STS (Spring Tool Suite) 49 | .springBeans 50 | 51 | # Code Recommenders 52 | .recommenders/ 53 | 54 | # Annotation Processing 55 | .apt_generated/ 56 | .apt_generated_test/ 57 | 58 | # Scala IDE specific (Scala & Java development for Eclipse) 59 | .cache-main 60 | .scala_dependencies 61 | .worksheet 62 | 63 | # Uncomment this line if you wish to ignore the project description file. 64 | # Typically, this file would be tracked if it contains build/dependency configurations: 65 | #.project 66 | 67 | ### Eclipse Patch ### 68 | # Spring Boot Tooling 69 | .sts4-cache/ 70 | 71 | ### Intellij ### 72 | # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider 73 | # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 74 | 75 | # User-specific stuff 76 | .idea/**/workspace.xml 77 | .idea/**/tasks.xml 78 | .idea/**/usage.statistics.xml 79 | .idea/**/dictionaries 80 | .idea/**/shelf 81 | 82 | # AWS User-specific 83 | .idea/**/aws.xml 84 | 85 | # Generated files 86 | .idea/**/contentModel.xml 87 | 88 | # Sensitive or high-churn files 89 | .idea/**/dataSources/ 90 | .idea/**/dataSources.ids 91 | .idea/**/dataSources.local.xml 92 | .idea/**/sqlDataSources.xml 93 | .idea/**/dynamic.xml 94 | .idea/**/uiDesigner.xml 95 | .idea/**/dbnavigator.xml 96 | 97 | # Gradle 98 | .idea/**/gradle.xml 99 | .idea/**/libraries 100 | 101 | # Gradle and Maven with auto-import 102 | # When using Gradle or Maven with auto-import, you should exclude module files, 103 | # since they will be recreated, and may cause churn. Uncomment if using 104 | # auto-import. 105 | # .idea/artifacts 106 | # .idea/compiler.xml 107 | # .idea/jarRepositories.xml 108 | # .idea/modules.xml 109 | # .idea/*.iml 110 | # .idea/modules 111 | # *.iml 112 | # *.ipr 113 | 114 | # CMake 115 | cmake-build-*/ 116 | 117 | # Mongo Explorer plugin 118 | .idea/**/mongoSettings.xml 119 | 120 | # File-based project format 121 | *.iws 122 | 123 | # IntelliJ 124 | out/ 125 | 126 | # mpeltonen/sbt-idea plugin 127 | .idea_modules/ 128 | 129 | # JIRA plugin 130 | atlassian-ide-plugin.xml 131 | 132 | # Cursive Clojure plugin 133 | .idea/replstate.xml 134 | 135 | # SonarLint plugin 136 | .idea/sonarlint/ 137 | 138 | # Crashlytics plugin (for Android Studio and IntelliJ) 139 | com_crashlytics_export_strings.xml 140 | crashlytics.properties 141 | crashlytics-build.properties 142 | fabric.properties 143 | 144 | # Editor-based Rest Client 145 | .idea/httpRequests 146 | 147 | # Android studio 3.1+ serialized cache file 148 | .idea/caches/build_file_checksums.ser 149 | 150 | ### Intellij Patch ### 151 | # Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721 152 | 153 | # *.iml 154 | # modules.xml 155 | # .idea/misc.xml 156 | # *.ipr 157 | 158 | # Sonarlint plugin 159 | # https://plugins.jetbrains.com/plugin/7973-sonarlint 160 | .idea/**/sonarlint/ 161 | 162 | # SonarQube Plugin 163 | # https://plugins.jetbrains.com/plugin/7238-sonarqube-community-plugin 164 | .idea/**/sonarIssues.xml 165 | 166 | # Markdown Navigator plugin 167 | # https://plugins.jetbrains.com/plugin/7896-markdown-navigator-enhanced 168 | .idea/**/markdown-navigator.xml 169 | .idea/**/markdown-navigator-enh.xml 170 | .idea/**/markdown-navigator/ 171 | 172 | # Cache file creation bug 173 | # See https://youtrack.jetbrains.com/issue/JBR-2257 174 | .idea/$CACHE_FILE$ 175 | 176 | # CodeStream plugin 177 | # https://plugins.jetbrains.com/plugin/12206-codestream 178 | .idea/codestream.xml 179 | 180 | # Azure Toolkit for IntelliJ plugin 181 | # https://plugins.jetbrains.com/plugin/8053-azure-toolkit-for-intellij 182 | .idea/**/azureSettings.xml 183 | 184 | ### Java ### 185 | # Compiled class file 186 | *.class 187 | 188 | # Log file 189 | *.log 190 | 191 | # BlueJ files 192 | *.ctxt 193 | 194 | # Mobile Tools for Java (J2ME) 195 | .mtj.tmp/ 196 | 197 | # Package Files # 198 | *.jar 199 | *.war 200 | *.nar 201 | *.ear 202 | *.zip 203 | *.tar.gz 204 | *.rar 205 | 206 | # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml 207 | hs_err_pid* 208 | replay_pid* -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # QuPath extension Cellsparse 2 | 3 | Train a deep learning model for cell segmentation in a few minutes from scratch. 4 | 5 | ![](https://github.com/ksugar/qupath-extension-cellsparse/releases/download/assets/cellsparse-demo.gif) 6 | 7 | This is a QuPath extension for [Cellsparse API](https://github.com/ksugar/cellsparse-api). 8 | 9 | This is a part of the following paper. Please [cite](#citation) it when you use this project. 10 | 11 | - Sugawara, K. [*Training deep learning models for cell image segmentation with sparse annotations.*](https://biorxiv.org/cgi/content/short/2023.06.13.544786v1) bioRxiv 2023. doi:10.1101/2023.06.13.544786 12 | 13 | ## Install & setup 14 | 15 | Drag and drop [the extension file](https://github.com/ksugar/qupath-extension-cellsparse/releases/download/v0.2.0/qupath-extension-cellsparse-0.2.0.jar) to [QuPath](https://qupath.github.io) and restart it. 16 | 17 | Set up the server following the instructions in the link below. 18 | 19 | [https://github.com/ksugar/cellsparse-api](https://github.com/ksugar/cellsparse-api) 20 | 21 | If you use [SAM API](https://github.com/ksugar/samapi) together with this API, you need to use different ports for them. 22 | 23 | For example, the following command will launch [Cellsparse API](https://github.com/ksugar/cellsparse-api) on the port `8000` (default). 24 | 25 | ```bash 26 | (cellsparse-api)$ uvicorn cellsparse_api.main:app 27 | INFO: Started server process [26240] 28 | INFO: Waiting for application startup. 29 | INFO: Application startup complete. 30 | INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) 31 | ``` 32 | 33 | Then, you can launch [SAM API](https://github.com/ksugar/samapi) on the port `18000` as follows. 34 | 35 | ```bash 36 | (samapi) samapi.main:app --port 18000 37 | INFO: Started server process [12060] 38 | INFO: Waiting for application startup. 39 | INFO: Application startup complete. 40 | INFO: Uvicorn running on http://127.0.0.1:18000 (Press CTRL+C to quit) 41 | ``` 42 | 43 | On QuPath, set the server URL for SAM (`Extensions` > `SAM` > `Server URL`) to `http://localhost:18000/sam/`. 44 | 45 | ![](https://github.com/ksugar/qupath-extension-sam/releases/download/assets/qupath-sam-extension-server-url.png) 46 | 47 | ## Usage 48 | 49 | Currently, [StarDist](https://stardist.net/index.html), [Cellpose](https://cellpose.readthedocs.io/en/latest/) and [ELEPHANT](https://elephant-track.github.io/) are available. 50 | 51 | ### `Extensions` > `Cellsparse` > `[Algorithm]` > `Training` 52 | 53 | Train a model with the annotations in the current image. 54 | 55 | In the training, foreground and background annotations need to be assigned to the annotation classes with the specific names, `Foreground` and `Background`, respectively. These names are case-sensitive. 56 | 57 | ![](https://github.com/ksugar/qupath-extension-cellsparse/releases/download/assets/qupath-extension-cellsparse-class-names.png) 58 | 59 | ### `Extensions` > `Cellsparse` > `[Algorithm]` > `Inference` 60 | 61 | Run inference with the latest model. 62 | 63 | ### `Extensions` > `Cellsparse` > `[Algorithm]` > `Reset` 64 | 65 | Reset a model (randomly initialized). 66 | 67 | ### `Extensions` > `Cellsparse` > `[Algorithm]` > `Server URL` 68 | 69 | Set the server URL for [Cellsparse API](https://github.com/ksugar/cellsparse-api). 70 | 71 | ## Citation 72 | 73 | Please cite my paper on [bioRxiv](https://biorxiv.org/cgi/content/short/2023.06.13.544786v1). 74 | 75 | ```.bib 76 | @article {Sugawara2023.06.13.544786, 77 | author = {Ko Sugawara}, 78 | title = {Training deep learning models for cell image segmentation with sparse annotations}, 79 | elocation-id = {2023.06.13.544786}, 80 | year = {2023}, 81 | doi = {10.1101/2023.06.13.544786}, 82 | publisher = {Cold Spring Harbor Laboratory}, 83 | abstract = {Deep learning is becoming more prominent in cell image analysis. However, collecting the annotated data required to train efficient deep-learning models remains a major obstacle. I demonstrate that functional performance can be achieved even with sparsely annotated data. Furthermore, I show that the selection of sparse cell annotations significantly impacts performance. I modified Cellpose and StarDist to enable training with sparsely annotated data and evaluated them in conjunction with ELEPHANT, a cell tracking algorithm that internally uses U-Net based cell segmentation. These results illustrate that sparse annotation is a generally effective strategy in deep learning-based cell image segmentation. Finally, I demonstrate that with the help of the Segment Anything Model (SAM), it is feasible to build an effective deep learning model of cell image segmentation from scratch just in a few minutes.Competing Interest StatementKS is employed part-time by LPIXEL Inc.}, 84 | URL = {https://www.biorxiv.org/content/early/2023/06/13/2023.06.13.544786}, 85 | eprint = {https://www.biorxiv.org/content/early/2023/06/13/2023.06.13.544786.full.pdf}, 86 | journal = {bioRxiv} 87 | } 88 | ``` -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 4 | 4.0.0 5 | org.elephant 6 | qupath-extension-cellsparse 7 | 0.2.0 8 | 9 | 10 | io.github.qupath 11 | qupath-gui-fx 12 | 0.4.3 13 | 14 | 15 | org.slf4j 16 | slf4j-api 17 | 2.0.4 18 | 19 | 20 | 21 | 22 | scijava.public 23 | https://maven.scijava.org/content/groups/public 24 | 25 | 26 | 27 | 11 28 | 11 29 | 30 | -------------------------------------------------------------------------------- /src/main/java/org/elephant/cellsparse/AbstractCellsparseCommands.java: -------------------------------------------------------------------------------- 1 | package org.elephant.cellsparse; 2 | 3 | import java.awt.image.BufferedImage; 4 | import java.io.ByteArrayOutputStream; 5 | import java.io.IOException; 6 | import java.lang.reflect.Type; 7 | import java.net.HttpURLConnection; 8 | import java.net.URI; 9 | import java.net.http.HttpClient; 10 | import java.net.http.HttpRequest; 11 | import java.net.http.HttpResponse; 12 | import java.util.Base64; 13 | import java.util.List; 14 | 15 | import javax.imageio.ImageIO; 16 | 17 | import com.google.gson.Gson; 18 | 19 | import ij.ImagePlus; 20 | import ij.plugin.ImageCalculator; 21 | import qupath.imagej.tools.IJTools; 22 | import qupath.lib.gui.dialogs.Dialogs; 23 | import qupath.lib.images.ImageData; 24 | import qupath.lib.images.servers.ImageServer; 25 | import qupath.lib.images.servers.LabeledImageServer; 26 | import qupath.lib.images.servers.LabeledOffsetImageServer; 27 | import qupath.lib.io.GsonTools; 28 | import qupath.lib.objects.PathObject; 29 | import qupath.lib.objects.classes.PathClass; 30 | 31 | public abstract class AbstractCellsparseCommands { 32 | 33 | private String base64Encode(final BufferedImage bufferedImage) { 34 | String base64Image = null; 35 | try { 36 | final ByteArrayOutputStream baos = new ByteArrayOutputStream(); 37 | ImageIO.write(bufferedImage, "png", baos); 38 | final byte[] bytes = baos.toByteArray(); 39 | base64Image = Base64.getEncoder().encodeToString(bytes); 40 | } catch (IOException e) { 41 | Dialogs.showErrorMessage(getClass().getName(), e); 42 | } 43 | return base64Image; 44 | } 45 | 46 | private BufferedImage readRegionFromServer( 47 | final ImageServer imageServer, 48 | final double downsample, 49 | final int x, 50 | final int y, 51 | final int width, 52 | final int height 53 | ) { 54 | BufferedImage image = null; 55 | try { 56 | image = imageServer.readRegion(downsample, x, y, width, height); 57 | } catch (IOException e) { 58 | Dialogs.showErrorMessage(getClass().getName(), e); 59 | } 60 | return image; 61 | } 62 | 63 | void CellsparseCommand(final ImageData imageData, final String endpointURL, final boolean train) { 64 | CellsparseCommand(imageData, endpointURL, train, 1, 8, 200); 65 | } 66 | 67 | void CellsparseCommand( 68 | final ImageData imageData, 69 | final String endpointURL, 70 | final boolean train, 71 | final int epochs, 72 | final int batchsize, 73 | final int steps 74 | ) { 75 | final BufferedImage image = readRegionFromServer( 76 | imageData.getServer(), 77 | 1.0, 78 | 0, 79 | 0, 80 | imageData.getServer().getWidth(), 81 | imageData.getServer().getHeight() 82 | ); 83 | final String strImage = base64Encode(image); 84 | 85 | final LabeledImageServer bgLabelServer = new LabeledImageServer.Builder(imageData) 86 | .backgroundLabel(0) 87 | .addLabel("Background", 1) 88 | .multichannelOutput(false) 89 | .build(); 90 | final BufferedImage bgImage = readRegionFromServer( 91 | bgLabelServer, 92 | 1.0, 93 | 0, 94 | 0, 95 | imageData.getServer().getWidth(), 96 | imageData.getServer().getHeight() 97 | ); 98 | final LabeledOffsetImageServer fgLabelServer = new LabeledOffsetImageServer.Builder(imageData) 99 | .useFilter(pathObject -> pathObject.getPathClass() == PathClass.getInstance("Foreground")) 100 | .useInstanceLabels() 101 | .offset(1) 102 | .build(); 103 | final BufferedImage fgImage = readRegionFromServer( 104 | fgLabelServer, 105 | 1.0, 106 | 0, 107 | 0, 108 | imageData.getServer().getWidth(), 109 | imageData.getServer().getHeight() 110 | ); 111 | final ImageCalculator imageCalculator = new ImageCalculator(); 112 | final ImagePlus bgImp = IJTools.convertToUncalibratedImagePlus("Background", bgImage); 113 | final ImagePlus fgImp = IJTools.convertToUncalibratedImagePlus("Foreground", fgImage); 114 | final BufferedImage lblImage = imageCalculator.run("Max", bgImp, fgImp).getBufferedImage(); 115 | final String strLabel = base64Encode(lblImage); 116 | final Gson gson = GsonTools.getInstance(); 117 | final CellsparseBody body = CellsparseBody.newBuilder("default") 118 | .b64img(strImage) 119 | .b64lbl(strLabel) 120 | .train(train) 121 | .eval(true) 122 | .epochs(epochs) 123 | .batchsize(batchsize) 124 | .steps(steps) 125 | .build(); 126 | final String bodyJson = gson.toJson(body); 127 | 128 | final HttpRequest request = HttpRequest.newBuilder() 129 | .version(HttpClient.Version.HTTP_1_1) 130 | .uri(URI.create(endpointURL)) 131 | .header("accept", "application/json") 132 | .header("Content-Type", "application/json; charset=utf-8") 133 | .POST(HttpRequest.BodyPublishers.ofString(bodyJson)) 134 | .build(); 135 | HttpClient client = HttpClient.newHttpClient(); 136 | final Type type = new com.google.gson.reflect.TypeToken>(){}.getType(); 137 | try { 138 | HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString()); 139 | if (response.statusCode() == HttpURLConnection.HTTP_OK) { 140 | List toRomove = imageData.getHierarchy().getAnnotationObjects() 141 | .stream().filter(pathObject -> pathObject.getPathClass() == null).toList(); 142 | imageData.getHierarchy().removeObjects(toRomove, false); 143 | List pathObjects = gson.fromJson(response.body(), type); 144 | imageData.getHierarchy().addObjects(pathObjects); 145 | } 146 | else { 147 | Dialogs.showErrorMessage("Http error: " + response.statusCode(), response.body()); 148 | } 149 | } catch (IOException | InterruptedException e) { 150 | e.printStackTrace(); 151 | Dialogs.showErrorMessage(getClass().getName(), e); 152 | } 153 | } 154 | 155 | void CellsparseResetCommand(final String endpointURL) { 156 | final Gson gson = GsonTools.getInstance(); 157 | final CellsparseResetBody body = CellsparseResetBody.newBuilder("default").build(); 158 | final String bodyJson = gson.toJson(body); 159 | 160 | final HttpRequest request = HttpRequest.newBuilder() 161 | .version(HttpClient.Version.HTTP_1_1) 162 | .uri(URI.create(endpointURL)) 163 | .header("accept", "application/json") 164 | .header("Content-Type", "application/json; charset=utf-8") 165 | .POST(HttpRequest.BodyPublishers.ofString(bodyJson)) 166 | .build(); 167 | HttpClient client = HttpClient.newHttpClient(); 168 | try { 169 | HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString()); 170 | if (response.statusCode() == HttpURLConnection.HTTP_OK) { 171 | Dialogs.showMessageDialog("Model reset", "Model is reset"); 172 | } 173 | else { 174 | Dialogs.showErrorMessage("Http error: " + response.statusCode(), response.body()); 175 | } 176 | } catch (IOException | InterruptedException e) { 177 | e.printStackTrace(); 178 | Dialogs.showErrorMessage(getClass().getName(), e); 179 | } 180 | } 181 | 182 | } 183 | -------------------------------------------------------------------------------- /src/main/java/org/elephant/cellsparse/CellsparseBody.java: -------------------------------------------------------------------------------- 1 | package org.elephant.cellsparse; 2 | 3 | 4 | public class CellsparseBody { 5 | 6 | @SuppressWarnings("unused") 7 | private String modelname; 8 | @SuppressWarnings("unused") 9 | private String b64img; 10 | @SuppressWarnings("unused") 11 | private String b64lbl; 12 | @SuppressWarnings("unused") 13 | private boolean train; 14 | @SuppressWarnings("unused") 15 | private boolean eval; 16 | @SuppressWarnings("unused") 17 | private int epochs; 18 | @SuppressWarnings("unused") 19 | private int batchsize; 20 | @SuppressWarnings("unused") 21 | private int steps; 22 | 23 | public CellsparseBody(final Builder builder) { 24 | this.modelname = builder.modelname; 25 | this.b64img = builder.b64img; 26 | this.b64lbl = builder.b64lbl; 27 | this.train = builder.train; 28 | this.eval = builder.eval; 29 | this.epochs = builder.epochs; 30 | this.batchsize = builder.batchsize; 31 | this.steps = builder.steps; 32 | } 33 | 34 | static class Builder { 35 | private String modelname; 36 | private String b64img; 37 | private String b64lbl = null; 38 | private boolean train = false; 39 | private boolean eval = false; 40 | private int epochs = 10; 41 | private int batchsize = 8; 42 | private int steps = 10; 43 | 44 | public Builder(final String modelname) { 45 | this.modelname = modelname; 46 | }; 47 | 48 | public Builder b64img(final String b64img) { 49 | this.b64img = b64img; 50 | return this; 51 | } 52 | 53 | public Builder b64lbl(final String b64lbl) { 54 | this.b64lbl = b64lbl; 55 | return this; 56 | } 57 | 58 | public Builder train(final boolean train) { 59 | this.train = train; 60 | return this; 61 | } 62 | 63 | public Builder eval(final boolean eval) { 64 | this.eval = eval; 65 | return this; 66 | } 67 | 68 | public Builder epochs(final int epochs) { 69 | this.epochs = epochs; 70 | return this; 71 | } 72 | 73 | public Builder batchsize(final int batchsize) { 74 | this.batchsize = batchsize; 75 | return this; 76 | } 77 | 78 | public Builder steps(final int steps) { 79 | this.steps = steps; 80 | return this; 81 | } 82 | 83 | public CellsparseBody build() { 84 | return new CellsparseBody(this); 85 | } 86 | } 87 | 88 | public static CellsparseBody.Builder newBuilder(final String modelname) { 89 | return new Builder(modelname); 90 | } 91 | } 92 | -------------------------------------------------------------------------------- /src/main/java/org/elephant/cellsparse/CellsparseCellposeExtension.java: -------------------------------------------------------------------------------- 1 | package org.elephant.cellsparse; 2 | 3 | import org.controlsfx.control.action.Action; 4 | import qupath.lib.gui.ActionTools; 5 | import qupath.lib.gui.QuPathGUI; 6 | import qupath.lib.gui.ActionTools.ActionDescription; 7 | import qupath.lib.gui.ActionTools.ActionMenu; 8 | import qupath.lib.gui.dialogs.Dialogs; 9 | import qupath.lib.gui.extensions.QuPathExtension; 10 | 11 | public class CellsparseCellposeExtension implements QuPathExtension { 12 | 13 | @Override 14 | public void installExtension(QuPathGUI qupath) { 15 | qupath.installActions(ActionTools.getAnnotatedActions(new CellsparseCellposeCommands(qupath))); 16 | } 17 | 18 | @Override 19 | public String getName() { 20 | return "Cellsparse Cellpose"; 21 | } 22 | 23 | @Override 24 | public String getDescription() { 25 | return "Cellpose with sparse annotation"; 26 | } 27 | 28 | @ActionMenu("Extensions>Cellsparse") 29 | public class CellsparseCellposeCommands extends AbstractCellsparseCommands { 30 | 31 | @ActionMenu("Cellpose>Training") 32 | @ActionDescription("Cellpose training with sparse annotation.") 33 | public final Action actionTraining; 34 | 35 | @ActionMenu("Cellpose>Inference") 36 | @ActionDescription("Cellpose inference.") 37 | public final Action actionInference; 38 | 39 | @ActionMenu("Cellpose>Reset") 40 | @ActionDescription("Reset Cellpose model.") 41 | public final Action actionReset; 42 | 43 | @ActionMenu("Cellpose>Server URL") 44 | @ActionDescription("Set API server URL.") 45 | public final Action actionSetServerURL; 46 | 47 | private String serverURL = "http://localhost:8000/cellpose/"; 48 | 49 | private CellsparseCellposeCommands(QuPathGUI qupath) { 50 | actionTraining = qupath.createImageDataAction(imageData -> { 51 | CellsparseCommand(imageData, serverURL, true, 5, 8, 200); 52 | }); 53 | 54 | actionInference = qupath.createImageDataAction(imageData -> { 55 | CellsparseCommand(imageData, serverURL, false); 56 | }); 57 | 58 | actionReset = new Action(e -> CellsparseResetCommand(serverURL + "reset/")); 59 | 60 | actionSetServerURL = new Action(event -> { 61 | String newURL = Dialogs.showInputDialog("Server URL", "Set API server URL", serverURL); 62 | if (newURL != null) { 63 | serverURL = newURL; 64 | } 65 | }); 66 | } 67 | 68 | } 69 | 70 | } 71 | -------------------------------------------------------------------------------- /src/main/java/org/elephant/cellsparse/CellsparseElephantExtension.java: -------------------------------------------------------------------------------- 1 | package org.elephant.cellsparse; 2 | 3 | import org.controlsfx.control.action.Action; 4 | import qupath.lib.gui.ActionTools; 5 | import qupath.lib.gui.QuPathGUI; 6 | import qupath.lib.gui.ActionTools.ActionDescription; 7 | import qupath.lib.gui.ActionTools.ActionMenu; 8 | import qupath.lib.gui.dialogs.Dialogs; 9 | import qupath.lib.gui.extensions.QuPathExtension; 10 | 11 | public class CellsparseElephantExtension implements QuPathExtension { 12 | 13 | @Override 14 | public void installExtension(QuPathGUI qupath) { 15 | qupath.installActions(ActionTools.getAnnotatedActions(new CellsparseElephantCommands(qupath))); 16 | } 17 | 18 | @Override 19 | public String getName() { 20 | return "Cellsparse ELEPHANT"; 21 | } 22 | 23 | @Override 24 | public String getDescription() { 25 | return "ELEPHANT with sparse annotation"; 26 | } 27 | 28 | @ActionMenu("Extensions>Cellsparse") 29 | public class CellsparseElephantCommands extends AbstractCellsparseCommands { 30 | 31 | @ActionMenu("ELEPHANT>Training") 32 | @ActionDescription("ELEPHANT training with sparse annotation.") 33 | public final Action actionTraining; 34 | 35 | @ActionMenu("ELEPHANT>Inference") 36 | @ActionDescription("ELEPHANT inference.") 37 | public final Action actionInference; 38 | 39 | @ActionMenu("ELEPHANT>Reset") 40 | @ActionDescription("Reset ELEPHANT model.") 41 | public final Action actionReset; 42 | 43 | @ActionMenu("ELEPHANT>Server URL") 44 | @ActionDescription("Set API server URL.") 45 | public final Action actionSetServerURL; 46 | 47 | private String serverURL = "http://localhost:8000/elephant/"; 48 | 49 | private CellsparseElephantCommands(QuPathGUI qupath) { 50 | actionTraining = qupath.createImageDataAction(imageData -> { 51 | CellsparseCommand(imageData, serverURL, true, 1, 8, 200); 52 | }); 53 | 54 | actionInference = qupath.createImageDataAction(imageData -> { 55 | CellsparseCommand(imageData, serverURL, false); 56 | }); 57 | 58 | actionReset = new Action(event -> CellsparseResetCommand(serverURL + "reset/")); 59 | 60 | actionSetServerURL = new Action(event -> { 61 | String newURL = Dialogs.showInputDialog("Server URL", "Set API server URL", serverURL); 62 | if (newURL != null) { 63 | serverURL = newURL; 64 | } 65 | }); 66 | } 67 | 68 | } 69 | 70 | } 71 | -------------------------------------------------------------------------------- /src/main/java/org/elephant/cellsparse/CellsparseResetBody.java: -------------------------------------------------------------------------------- 1 | package org.elephant.cellsparse; 2 | 3 | 4 | public class CellsparseResetBody { 5 | 6 | @SuppressWarnings("unused") 7 | private String modelname; 8 | 9 | public CellsparseResetBody(final Builder builder) { 10 | this.modelname = builder.modelname; 11 | } 12 | 13 | static class Builder { 14 | private String modelname; 15 | 16 | public Builder(final String modelname) { 17 | this.modelname = modelname; 18 | }; 19 | 20 | public CellsparseResetBody build() { 21 | return new CellsparseResetBody(this); 22 | } 23 | } 24 | 25 | public static CellsparseResetBody.Builder newBuilder(final String modelname) { 26 | return new Builder(modelname); 27 | } 28 | } 29 | -------------------------------------------------------------------------------- /src/main/java/org/elephant/cellsparse/CellsparseStarDistExtension.java: -------------------------------------------------------------------------------- 1 | package org.elephant.cellsparse; 2 | 3 | import org.controlsfx.control.action.Action; 4 | import qupath.lib.gui.ActionTools; 5 | import qupath.lib.gui.QuPathGUI; 6 | import qupath.lib.gui.ActionTools.ActionDescription; 7 | import qupath.lib.gui.ActionTools.ActionMenu; 8 | import qupath.lib.gui.dialogs.Dialogs; 9 | import qupath.lib.gui.extensions.QuPathExtension; 10 | 11 | public class CellsparseStarDistExtension implements QuPathExtension { 12 | 13 | @Override 14 | public void installExtension(QuPathGUI qupath) { 15 | qupath.installActions(ActionTools.getAnnotatedActions(new CellsparseStarDistCommands(qupath))); 16 | } 17 | 18 | @Override 19 | public String getName() { 20 | return "Cellsparse StarDist"; 21 | } 22 | 23 | @Override 24 | public String getDescription() { 25 | return "StarDist with sparse annotation"; 26 | } 27 | 28 | @ActionMenu("Extensions>Cellsparse") 29 | public class CellsparseStarDistCommands extends AbstractCellsparseCommands { 30 | 31 | @ActionMenu("StarDist>Training") 32 | @ActionDescription("StarDist training with sparse annotation.") 33 | public final Action actionTraining; 34 | 35 | @ActionMenu("StarDist>Inference") 36 | @ActionDescription("StarDist inference.") 37 | public final Action actionInference; 38 | 39 | @ActionMenu("StarDist>Reset") 40 | @ActionDescription("Reset StarDist model.") 41 | public final Action actionReset; 42 | 43 | @ActionMenu("StarDist>Server URL") 44 | @ActionDescription("Set API server URL.") 45 | public final Action actionSetServerURL; 46 | 47 | private String serverURL = "http://localhost:8000/stardist/"; 48 | 49 | private CellsparseStarDistCommands(QuPathGUI qupath) { 50 | actionTraining = qupath.createImageDataAction(imageData -> { 51 | CellsparseCommand(imageData, serverURL, true, 1, 8, 200); 52 | }); 53 | 54 | actionInference = qupath.createImageDataAction(imageData -> { 55 | CellsparseCommand(imageData, serverURL, false); 56 | }); 57 | 58 | actionReset = new Action(e -> CellsparseResetCommand(serverURL + "reset/")); 59 | 60 | actionSetServerURL = new Action(event -> { 61 | String newURL = Dialogs.showInputDialog("Server URL", "Set API server URL", serverURL); 62 | if (newURL != null) { 63 | serverURL = newURL; 64 | } 65 | }); 66 | } 67 | 68 | } 69 | 70 | } 71 | -------------------------------------------------------------------------------- /src/main/java/qupath/lib/images/servers/LabeledOffsetImageServer.java: -------------------------------------------------------------------------------- 1 | /*- 2 | * #%L 3 | * This file is part of QuPath. 4 | * %% 5 | * Copyright (C) 2018 - 2020 QuPath developers, The University of Edinburgh 6 | * %% 7 | * QuPath is free software: you can redistribute it and/or modify 8 | * it under the terms of the GNU General Public License as 9 | * published by the Free Software Foundation, either version 3 of the 10 | * License, or (at your option) any later version. 11 | * 12 | * QuPath is distributed in the hope that it will be useful, 13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | * GNU General Public License for more details. 16 | * 17 | * You should have received a copy of the GNU General Public License 18 | * along with QuPath. If not, see . 19 | * #L% 20 | */ 21 | 22 | package qupath.lib.images.servers; 23 | 24 | import java.awt.BasicStroke; 25 | import java.awt.Color; 26 | import java.awt.Graphics2D; 27 | import java.awt.image.BandedSampleModel; 28 | import java.awt.image.BufferedImage; 29 | import java.awt.image.ColorModel; 30 | import java.awt.image.DataBuffer; 31 | import java.awt.image.DataBufferByte; 32 | import java.awt.image.WritableRaster; 33 | import java.io.IOException; 34 | import java.net.URI; 35 | import java.util.ArrayList; 36 | import java.util.Collection; 37 | import java.util.Collections; 38 | import java.util.HashMap; 39 | import java.util.LinkedHashMap; 40 | import java.util.List; 41 | import java.util.Map; 42 | import java.util.Random; 43 | import java.util.TreeMap; 44 | import java.util.UUID; 45 | import java.util.function.Function; 46 | import java.util.function.Predicate; 47 | import java.util.stream.Collectors; 48 | 49 | import org.slf4j.Logger; 50 | import org.slf4j.LoggerFactory; 51 | 52 | import qupath.lib.color.ColorMaps; 53 | import qupath.lib.color.ColorModelFactory; 54 | import qupath.lib.color.ColorToolsAwt; 55 | import qupath.lib.common.ColorTools; 56 | import qupath.lib.images.ImageData; 57 | import qupath.lib.images.servers.ImageServerMetadata.ChannelType; 58 | import qupath.lib.images.servers.ImageServerBuilder.ServerBuilder; 59 | import qupath.lib.objects.PathObject; 60 | import qupath.lib.objects.PathObjectFilter; 61 | import qupath.lib.objects.PathObjectTools; 62 | import qupath.lib.objects.classes.PathClass; 63 | import qupath.lib.objects.hierarchy.PathObjectHierarchy; 64 | import qupath.lib.regions.ImageRegion; 65 | import qupath.lib.regions.RegionRequest; 66 | import qupath.lib.roi.RoiTools; 67 | import qupath.lib.roi.interfaces.ROI; 68 | 69 | 70 | /** 71 | * A special ImageServer implementation that doesn't have a backing image, but rather 72 | * constructs tiles from a {@link PathObjectHierarchy} where pixel values are integer labels corresponding 73 | * stored and classified annotations. 74 | *

75 | * Warning! This is intend for temporary use when exporting labelled images. No attempt is made to 76 | * respond to changes within the hierarchy. For consistent results, the hierarchy must remain static for the 77 | * time in which this server is being used. 78 | * 79 | * @author Pete Bankhead 80 | * 81 | */ 82 | public class LabeledOffsetImageServer extends AbstractTileableImageServer implements GeneratingImageServer { 83 | 84 | private static final Logger logger = LoggerFactory.getLogger(LabeledOffsetImageServer.class); 85 | 86 | private ImageServerMetadata originalMetadata; 87 | 88 | // Easy way to get the default color models... 89 | private static final ColorModel COLOR_MODEL_GRAY_UINT8 = new BufferedImage(1, 1, BufferedImage.TYPE_BYTE_GRAY).getColorModel(); 90 | private static final ColorModel COLOR_MODEL_GRAY_UINT16 = new BufferedImage(1, 1, BufferedImage.TYPE_USHORT_GRAY).getColorModel(); 91 | 92 | private PathObjectHierarchy hierarchy; 93 | 94 | private ColorModel colorModel; 95 | private boolean multichannelOutput; 96 | 97 | private LabeledServerParameters params; 98 | 99 | /** 100 | * The maximum requested label; this is used to determine the output depth for indexed images. 101 | */ 102 | private int maxLabel; 103 | 104 | private Map instanceClassMap = null; 105 | private Map instanceClassMapInverse = null; 106 | 107 | private LabeledOffsetImageServer(final ImageData imageData, double downsample, int tileWidth, int tileHeight, LabeledServerParameters params, boolean multichannelOutput, int offset) { 108 | super(); 109 | 110 | this.multichannelOutput = multichannelOutput; 111 | this.hierarchy = imageData.getHierarchy(); 112 | 113 | this.params = params; 114 | 115 | var server = imageData.getServer(); 116 | 117 | // Generate mapping for labels; it is permissible to have multiple classes for the same labels, in which case a derived class will be used 118 | Map classificationLabels = new TreeMap<>(); 119 | if (params.createInstanceLabels) { 120 | var pathObjects = imageData.getHierarchy().getObjects(null, null).stream() 121 | .filter(params.objectFilter) 122 | .collect(Collectors.toCollection(ArrayList::new)); 123 | // Shuffle the objects, this helps when using grayscale lookup tables, since labels for neighboring objects are otherwise very similar 124 | if (params.shuffleInstanceLabels) 125 | Collections.shuffle(pathObjects, new Random(100L)); 126 | Integer count = multichannelOutput ? 0 : offset + 1; 127 | instanceClassMap = new HashMap<>(); 128 | instanceClassMapInverse = new HashMap<>(); 129 | for (var pathObject : pathObjects) { 130 | var pathClass = instanceLabelToClass(count); 131 | instanceClassMap.put(pathObject, count); 132 | instanceClassMapInverse.put(count, pathObject); 133 | classificationLabels.put(count, pathClass); 134 | params.labelColors.put(count, pathClass.getColor()); 135 | params.labels.put(pathClass, count); 136 | count++; 137 | } 138 | } else { 139 | for (var entry : params.labels.entrySet()) { 140 | var pathClass = getPathClass(entry.getKey()); 141 | var label = entry.getValue(); 142 | var previousClass = classificationLabels.put(label, pathClass); 143 | if (previousClass != null && previousClass != PathClass.NULL_CLASS) { 144 | classificationLabels.put(label, PathClass.getInstance(previousClass, pathClass.getName(), null)); 145 | } 146 | } 147 | } 148 | 149 | for (var entry : params.boundaryLabels.entrySet()) { 150 | var pathClass = getPathClass(entry.getKey()); 151 | var label = entry.getValue(); 152 | var previousClass = classificationLabels.put(label, pathClass); 153 | if (previousClass != null && previousClass != PathClass.NULL_CLASS) { 154 | classificationLabels.put(label, PathClass.getInstance(previousClass, pathClass.getName(), null)); 155 | } 156 | } 157 | 158 | if (tileWidth <= 0) 159 | tileWidth = 512; 160 | if (tileHeight <= 0) 161 | tileHeight = tileWidth; 162 | 163 | var metadataBuilder = new ImageServerMetadata.Builder(server.getMetadata()) 164 | .preferredTileSize(tileWidth, tileHeight) 165 | .levelsFromDownsamples(downsample) 166 | .pixelType(PixelType.UINT8) 167 | .rgb(false); 168 | 169 | // Check the labels are valid 170 | var labelStats = classificationLabels.keySet().stream().mapToInt(i -> i).summaryStatistics(); 171 | int minLabel = labelStats.getMin(); 172 | maxLabel = labelStats.getMax(); 173 | if (minLabel < 0) { 174 | throw new IllegalArgumentException("Minimum possible label value is 0! Requested minimum was " + maxLabel); 175 | } 176 | if (multichannelOutput) { 177 | int nChannels = maxLabel + 1; 178 | if (params.maxOutputChannelLimit > 0 && nChannels > params.maxOutputChannelLimit) 179 | throw new IllegalArgumentException("You've requested " + nChannels + " output channels, but the maximum supported number is " + params.maxOutputChannelLimit); 180 | } 181 | 182 | if (multichannelOutput) { 183 | int nLabels = maxLabel - minLabel + 1; 184 | if (minLabel != 0 || nLabels != classificationLabels.size()) { 185 | throw new IllegalArgumentException("Labels for multichannel output must be consecutive integers starting from 0! Requested labels " + classificationLabels.keySet()); 186 | } 187 | var channels = ServerTools.classificationLabelsToChannels(classificationLabels, false); 188 | // It's a bit sad... but if we want grayscale output, we need to set the channels here 189 | if (params.grayscaleLut) 190 | channels = channels.stream().map(c -> ImageChannel.getInstance(c.getName(), ColorTools.WHITE)).collect(Collectors.toList()); 191 | metadataBuilder = metadataBuilder 192 | .channelType(ChannelType.MULTICLASS_PROBABILITY) 193 | .channels(channels) 194 | .classificationLabels(classificationLabels); 195 | colorModel = ColorModelFactory.createColorModel(PixelType.UINT8, channels); 196 | } else { 197 | metadataBuilder = metadataBuilder 198 | .channelType(ChannelType.CLASSIFICATION) 199 | .classificationLabels(classificationLabels); 200 | 201 | // Update the color map, ensuring we don't have null 202 | var colors = new LinkedHashMap(); 203 | for (var entry : params.labelColors.entrySet()) { 204 | var key = entry.getKey(); 205 | var value = entry.getValue(); 206 | if (key == null) { 207 | logger.debug("Missing key in label map! Will be skipped."); 208 | continue; 209 | } 210 | if (value == null) { 211 | // Flip the bits of the background color, if needed 212 | logger.debug("Missing color in label map! Will be derived from the background color."); 213 | var backgroundColor = params.labelColors.get(params.labels.get(params.unannotatedClass)); 214 | value = backgroundColor == null ? 0 : ~backgroundColor.intValue(); 215 | } 216 | colors.put(key, value); 217 | } 218 | 219 | if (params.grayscaleLut) { 220 | if (maxLabel < 255) 221 | colorModel = COLOR_MODEL_GRAY_UINT8; 222 | else if (maxLabel < 65536){ 223 | colorModel = COLOR_MODEL_GRAY_UINT16; 224 | metadataBuilder.pixelType(PixelType.UINT16); 225 | } else { 226 | colorModel = ColorModelFactory.createColorModel(PixelType.FLOAT32, 227 | ColorMaps.createColorMap("labels", 255, 255, 255), 228 | 0, 229 | 0, 230 | maxLabel, 231 | -1, 232 | null); 233 | metadataBuilder.pixelType(PixelType.FLOAT32); 234 | } 235 | } else { 236 | if (maxLabel < 65536) { 237 | colorModel = ColorModelFactory.createIndexedColorModel(colors, false); 238 | if (maxLabel > 255) 239 | metadataBuilder.pixelType(PixelType.UINT16); 240 | } else { 241 | colorModel = ColorModelFactory.getDummyColorModel(32); 242 | metadataBuilder.channels(ImageChannel.getDefaultRGBChannels()); 243 | } 244 | } 245 | } 246 | 247 | // Set metadata, using the underlying server as a basis 248 | this.originalMetadata = metadataBuilder.build(); 249 | } 250 | 251 | /** 252 | * @param pathClass 253 | * @return the input classification, or the unclassified classification if the input is null 254 | */ 255 | private static PathClass getPathClass(PathClass pathClass) { 256 | return pathClass == null ? PathClass.NULL_CLASS : pathClass; 257 | } 258 | 259 | /** 260 | * Get a standardized classification for an object. 261 | * If unique labels are requested, this will return the unique classification associated with this object 262 | * or null if no unique classification is available (i.e. the object should not be included). 263 | * Otherwise, it will return either the objects's classification or the unclassified class (not null). 264 | * @param pathObject 265 | * @return 266 | */ 267 | private PathClass getPathClass(PathObject pathObject) { 268 | if (instanceClassMap != null) 269 | return instanceLabelToClass(instanceClassMap.get(pathObject)); 270 | return getPathClass(pathObject.getPathClass()); 271 | } 272 | 273 | 274 | private static PathClass instanceLabelToClass(Integer label) { 275 | if (label == null) 276 | return null; 277 | return PathClass.getInstance("Label " + label); 278 | } 279 | 280 | // /** 281 | // * Get the label associated with a specific {@link PathObject}. 282 | // * This will be based on the instance if {@link Builder#useInstanceLabels()} is selected, 283 | // * or the classification. 284 | // * @param pathObject 285 | // * @return the label if available, or null if no label is associated with the object 286 | // */ 287 | // public Integer getLabel(PathObject pathObject) { 288 | // if (!this.params.objectFilter.test(pathObject)) 289 | // return null; 290 | // if (params.createInstanceLabels) 291 | // return instanceClassMap.get(pathObject); 292 | // return params.labels.get(getPathClass(pathObject)); 293 | // } 294 | 295 | /** 296 | * Get a mapping between objects and instance labels. 297 | * @return the instance label map, or an empty map if no objects are available or 298 | * {@link Builder#useInstanceLabels()} was not selected. 299 | */ 300 | public Map getInstanceLabels() { 301 | if (instanceClassMap == null) 302 | return Collections.emptyMap(); 303 | return Collections.unmodifiableMap(instanceClassMap); 304 | } 305 | 306 | /** 307 | * Get an unmodifiable map of classifications and their corresponding labels. 308 | * Note that multiple classifications may use the same integer label. 309 | * @return a map of labels, or empty map if none are available or {@code useInstanceLabels()} was selected. 310 | */ 311 | public Map getLabels() { 312 | if (params.createInstanceLabels) 313 | return Collections.emptyMap(); 314 | return Collections.unmodifiableMap(params.labels); 315 | } 316 | 317 | /** 318 | * Get an unmodifiable map of classifications and their corresponding boundary labels, if available. 319 | * Note that multiple classifications may use the same integer label. 320 | * @return a map of boundary labels, or empty map if none are available or {@code useInstanceLabels()} was selected. 321 | */ 322 | public Map getBoundaryLabels() { 323 | if (params.createInstanceLabels) 324 | return Collections.emptyMap(); 325 | return Collections.unmodifiableMap(params.boundaryLabels); 326 | } 327 | 328 | 329 | 330 | private static class LabeledServerParameters { 331 | 332 | /** 333 | * Background class (name must not clash with any 'real' class) 334 | * Previously, this was achieved with a UUID - although this looks strange if exporting classes. 335 | */ 336 | // private PathClass unannotatedClass = PathClassFactory.getPathClass("Unannotated " + UUID.randomUUID().toString()); 337 | private PathClass unannotatedClass = PathClass.getInstance("*Background*"); 338 | 339 | private Predicate objectFilter = PathObjectFilter.ANNOTATIONS; 340 | private Function roiFunction = p -> p.getROI(); 341 | 342 | private boolean createInstanceLabels = false; 343 | private boolean shuffleInstanceLabels = true; // Only if using instance labels 344 | 345 | private int maxOutputChannelLimit = 256; 346 | 347 | private boolean grayscaleLut = false; 348 | 349 | private float lineThickness = 1.0f; 350 | private Map labels = new LinkedHashMap<>(); 351 | private Map boundaryLabels = new LinkedHashMap<>(); 352 | private Map labelColors = new LinkedHashMap<>(); 353 | 354 | LabeledServerParameters() { 355 | labels.put(unannotatedClass, 0); 356 | labelColors.put(0, ColorTools.WHITE); 357 | } 358 | 359 | LabeledServerParameters(LabeledServerParameters params) { 360 | this.unannotatedClass = params.unannotatedClass; 361 | this.lineThickness = params.lineThickness; 362 | this.objectFilter = params.objectFilter; 363 | this.labels = new LinkedHashMap<>(params.labels); 364 | this.boundaryLabels = new LinkedHashMap<>(params.boundaryLabels); 365 | this.labelColors = new LinkedHashMap<>(params.labelColors); 366 | this.createInstanceLabels = params.createInstanceLabels; 367 | this.maxOutputChannelLimit = params.maxOutputChannelLimit; 368 | this.roiFunction = params.roiFunction; 369 | this.grayscaleLut = params.grayscaleLut; 370 | this.shuffleInstanceLabels = params.shuffleInstanceLabels; 371 | } 372 | 373 | } 374 | 375 | /** 376 | * Helper class for building a {@link LabeledImageServer}. 377 | */ 378 | public static class Builder { 379 | 380 | private ImageData imageData; 381 | private double downsample = 1.0; 382 | private int tileWidth, tileHeight; 383 | 384 | private boolean multichannelOutput = false; 385 | 386 | private int offset = 0; 387 | 388 | private LabeledServerParameters params = new LabeledServerParameters(); 389 | 390 | /** 391 | * Create a Builder for a {@link LabeledImageServer} for the specified {@link ImageData}. 392 | * @param imageData 393 | */ 394 | public Builder(ImageData imageData) { 395 | this.imageData = imageData; 396 | } 397 | 398 | /** 399 | * Use detections rather than annotations for labels. 400 | * The default is to use annotations. 401 | * @return 402 | * @see #useAnnotations() 403 | */ 404 | public Builder useDetections() { 405 | params.objectFilter = PathObjectFilter.DETECTIONS_ALL; 406 | return this; 407 | } 408 | 409 | /** 410 | * Use cells rather than annotations for labels. 411 | * The default is to use annotations. 412 | * @return 413 | * @see #useAnnotations() 414 | */ 415 | public Builder useCells() { 416 | params.objectFilter = PathObjectFilter.CELLS; 417 | return this; 418 | } 419 | 420 | /** 421 | * Use cells rather than annotations for labels, requesting the nucleus ROI where available. 422 | * The default is to use annotations. 423 | * @return 424 | * @see #useAnnotations() 425 | */ 426 | public Builder useCellNuclei() { 427 | params.objectFilter = PathObjectFilter.CELLS; 428 | params.roiFunction = p -> PathObjectTools.getROI(p, true); 429 | return this; 430 | } 431 | 432 | /** 433 | * Use annotations for labels. This is the default. 434 | * @return 435 | * @see #useDetections() 436 | */ 437 | public Builder useAnnotations() { 438 | params.objectFilter = PathObjectFilter.ANNOTATIONS; 439 | return this; 440 | } 441 | 442 | /** 443 | * Use a custom method of selecting objects for inclusion. 444 | * The default is to use annotations. 445 | * @param filter the filter that determines whether an object will be included or not 446 | * @return 447 | * @see #useAnnotations() 448 | */ 449 | public Builder useFilter(Predicate filter) { 450 | params.objectFilter = filter; 451 | return this; 452 | } 453 | 454 | /** 455 | * Use grayscale LUT, rather than deriving colors from classifications. 456 | * This can streamline import in software that automatically converts paletted images to RGB. 457 | * @return 458 | * @since v0.4.0 459 | * @see #grayscale(boolean) 460 | */ 461 | public Builder grayscale() { 462 | return grayscale(true); 463 | } 464 | 465 | /** 466 | * Optionally use grayscale LUT, rather than deriving colors from classifications. 467 | * This can streamline import in software that automatically converts paletted images to RGB. 468 | * @param grayscaleLut 469 | * @return 470 | * @since v0.4.0 471 | * @see #grayscale() 472 | */ 473 | public Builder grayscale(boolean grayscaleLut) { 474 | params.grayscaleLut = grayscaleLut; 475 | return this; 476 | } 477 | 478 | /** 479 | * Specify downsample factor. This is very important because it defines 480 | * the resolution at which shapes will be drawn and the line thickness is determined. 481 | * @param downsample 482 | * @return 483 | */ 484 | public Builder downsample(double downsample) { 485 | this.downsample = downsample; 486 | return this; 487 | } 488 | 489 | /** 490 | * Set tile width and height (square tiles). 491 | * @param tileSize 492 | * @return 493 | */ 494 | public Builder tileSize(int tileSize) { 495 | return tileSize(tileSize, tileSize); 496 | } 497 | 498 | /** 499 | * Set tile width and height. 500 | * @param tileWidth 501 | * @param tileHeight 502 | * @return 503 | */ 504 | public Builder tileSize(int tileWidth, int tileHeight) { 505 | this.tileWidth = tileWidth; 506 | this.tileHeight = tileHeight; 507 | return this; 508 | } 509 | 510 | /** 511 | * Thickness of boundary lines and line annotations, defined in terms of pixels at the 512 | * resolution specified by the downsample value of the server. 513 | * @param thickness 514 | * @return 515 | */ 516 | public Builder lineThickness(float thickness) { 517 | params.lineThickness = thickness; 518 | return this; 519 | } 520 | 521 | 522 | /** 523 | * @return 524 | * @deprecated in favor of {@link #useInstanceLabels()} 525 | */ 526 | @Deprecated 527 | public Builder useUniqueLabels() { 528 | logger.warn("useUniqueLabels() is deprecated; please switch to useInstanceLabels() instead."); 529 | return useInstanceLabels(); 530 | } 531 | 532 | /** 533 | * Request that unique labels are used for all objects, rather than classifications. 534 | * If this flag is set, all other label requests are ignored. 535 | * @return 536 | * @see #useInstanceLabels(boolean) 537 | * @see #shuffleInstanceLabels(boolean) 538 | */ 539 | public Builder useInstanceLabels() { 540 | return useInstanceLabels(true); 541 | } 542 | 543 | /** 544 | * Optionally request that unique labels are used for all objects, rather than classifications. 545 | * If this flag is set, all other label requests are ignored. 546 | * @param instanceLabels 547 | * @return 548 | * @since v0.4.0 549 | * @see #useInstanceLabels() 550 | * @see #shuffleInstanceLabels(boolean) 551 | */ 552 | public Builder useInstanceLabels(boolean instanceLabels) { 553 | params.createInstanceLabels = instanceLabels; 554 | return this; 555 | } 556 | 557 | 558 | /** 559 | * Optionally request that instance labels are shuffled. 560 | * Default is true. 561 | * Only has an effect if {@link #useInstanceLabels(boolean)} is called with {@code true}. 562 | * @param doShuffle 563 | * @return 564 | * @since v0.4.0 565 | * @see #useInstanceLabels() 566 | * @see #useInstanceLabels(boolean) 567 | */ 568 | public Builder shuffleInstanceLabels(boolean doShuffle) { 569 | params.shuffleInstanceLabels = doShuffle; 570 | return this; 571 | } 572 | 573 | 574 | /** 575 | * If true, the output image consists of multiple binary images concatenated as different channels, 576 | * so that the channel number relates to a classification. 577 | * If false, the output image is a single-channel indexed image so that each pixel value relates to 578 | * a classification. 579 | * Indexed images are much more efficient, but are unable to support more than one classification per pixel. 580 | * @param doMultichannel 581 | * @return 582 | */ 583 | public Builder multichannelOutput(boolean doMultichannel) { 584 | this.multichannelOutput = doMultichannel; 585 | return this; 586 | } 587 | 588 | public Builder offset(int offset) { 589 | this.offset = offset; 590 | return this; 591 | } 592 | 593 | /** 594 | * Specify the background label (0 by default). 595 | * @param label 596 | * @return 597 | */ 598 | public Builder backgroundLabel(int label) { 599 | return backgroundLabel(label, ColorTools.packRGB(255, 255, 255)); 600 | } 601 | 602 | /** 603 | * Specify the background label (0 by default) and color. 604 | * @param label 605 | * @param color 606 | * @return 607 | */ 608 | public Builder backgroundLabel(int label, Integer color) { 609 | addLabel(params.unannotatedClass, label, color); 610 | return this; 611 | } 612 | 613 | /** 614 | * Add multiple labels by classname, where the key represents a classname and the value 615 | * represents the integer label that should be used for annotations of the given class. 616 | * @param labelMap 617 | * @return 618 | */ 619 | public Builder addLabelsByName(Map labelMap) { 620 | for (var entry : labelMap.entrySet()) 621 | addLabel(entry.getKey(), entry.getValue()); 622 | return this; 623 | } 624 | 625 | /** 626 | * Add multiple labels by PathClass, where the key represents a PathClass and the value 627 | * represents the integer label that should be used for annotations of the given class. 628 | * @param labelMap 629 | * @return 630 | */ 631 | public Builder addLabels(Map labelMap) { 632 | for (var entry : labelMap.entrySet()) 633 | addLabel(entry.getKey(), entry.getValue()); 634 | return this; 635 | } 636 | 637 | /** 638 | * Add a single label by classname, where the label represents the integer label used for 639 | * annotations with the given classname. 640 | * @param pathClassName 641 | * @param label 642 | * @return 643 | */ 644 | public Builder addLabel(String pathClassName, int label) { 645 | return addLabel(pathClassName, label, null); 646 | } 647 | 648 | /** 649 | * Add a single label by classname, where the label represents the integer label used for 650 | * annotations with the given classname. 651 | * @param pathClassName 652 | * @param label the indexed image pixel value or channel number for the given classification 653 | * @param color the color of the lookup table used with any indexed image 654 | * @return 655 | */ 656 | public Builder addLabel(String pathClassName, int label, Integer color) { 657 | return addLabel(PathClass.fromString(pathClassName), label, color); 658 | } 659 | 660 | /** 661 | * Add a single label by {@link PathClass}, where the label represents the integer label used for 662 | * annotations with the given classification. 663 | * @param pathClass 664 | * @param label the indexed image pixel value or channel number for the given classification 665 | * @return 666 | */ 667 | public Builder addLabel(PathClass pathClass, int label) { 668 | return addLabel(pathClass, label, null); 669 | } 670 | 671 | /** 672 | * Add a single label by {@link PathClass}, where the label represents the integer label used for 673 | * annotations with the given classification. 674 | * @param pathClass 675 | * @param label the indexed image pixel value or channel number for the given classification 676 | * @param color the color of the lookup table used with any indexed image 677 | * @return 678 | */ 679 | public Builder addLabel(PathClass pathClass, int label, Integer color) { 680 | return addLabel(params.labels, pathClass, label, color); 681 | } 682 | 683 | /** 684 | * Add a single label for objects that are unclassified, where the label represents the integer label used for 685 | * annotations that have no classification set. 686 | * @param label the indexed image pixel value or channel number without a classification 687 | * @param color the color of the lookup table used with any indexed image 688 | * @return 689 | */ 690 | public Builder addUnclassifiedLabel(int label, Integer color) { 691 | return addLabel(params.labels, PathClass.NULL_CLASS, label, color); 692 | } 693 | 694 | /** 695 | * Add a single label for objects that are unclassified, where the label represents the integer label used for 696 | * annotations that have no classification set. 697 | * @param label the indexed image pixel value or channel number without a classification 698 | * @return 699 | */ 700 | public Builder addUnclassifiedLabel(int label) { 701 | return addLabel(params.labels, PathClass.NULL_CLASS, label, null); 702 | } 703 | 704 | 705 | /** 706 | * Set the classification and label to use for boundaries for classified areas. 707 | * @param pathClass 708 | * @param label the indexed image pixel value or channel number for the given classification 709 | * @return 710 | */ 711 | public Builder setBoundaryLabel(PathClass pathClass, int label) { 712 | return setBoundaryLabel(pathClass, label, null); 713 | } 714 | 715 | /** 716 | * Set the classification and label to use for boundaries for classified areas. 717 | * @param pathClass 718 | * @param label the indexed image pixel value or channel number for the given classification 719 | * @param color the color of the lookup table used with any indexed image 720 | * @return 721 | */ 722 | public Builder setBoundaryLabel(PathClass pathClass, int label, Integer color) { 723 | params.boundaryLabels.clear(); 724 | return addLabel(params.boundaryLabels, pathClass, label, color); 725 | } 726 | 727 | /** 728 | * Set the classification and label to use for boundaries for classified areas. 729 | * @param pathClassName 730 | * @param label the indexed image pixel value or channel number for the given classification 731 | * @return 732 | */ 733 | public Builder setBoundaryLabel(String pathClassName, int label) { 734 | return setBoundaryLabel(pathClassName, label, null); 735 | } 736 | 737 | /** 738 | * Set the classification and label to use for boundaries for classified areas. 739 | * @param pathClassName 740 | * @param label the indexed image pixel value or channel number for the given classification 741 | * @param color the color of the lookup table used with any indexed image 742 | * @return 743 | */ 744 | public Builder setBoundaryLabel(String pathClassName, int label, Integer color) { 745 | return setBoundaryLabel(PathClass.fromString(pathClassName), label, color); 746 | } 747 | 748 | private Builder addLabel(Map map, PathClass pathClass, int label, Integer color) { 749 | pathClass = getPathClass(pathClass); 750 | map.put(pathClass, label); 751 | if (color != null) 752 | params.labelColors.put(label, color); 753 | else if (!params.labelColors.containsKey(label)) 754 | params.labelColors.put(label, pathClass.getColor()); 755 | return this; 756 | } 757 | 758 | /** 759 | * Specify the maximum number of output channels allowed before QuPath will throw an exception. 760 | * This is used to guard against inadvertently requesting a labelled image that would have an infeasibly 761 | * large number of output channels, most commonly with {@link #useInstanceLabels()}. 762 | * @param maxChannels the maximum supported channels; set (cautiously!) ≤ 0 to ignore the limit entirely. 763 | * @return 764 | */ 765 | public Builder maxOutputChannelLimit(int maxChannels) { 766 | params.maxOutputChannelLimit = maxChannels; 767 | return this; 768 | } 769 | 770 | /** 771 | * Build the {@link ImageServer} with the requested parameters. 772 | * @return 773 | */ 774 | public LabeledOffsetImageServer build() { 775 | if (params.createInstanceLabels) { 776 | if (!(params.labels.isEmpty() || (params.labels.size() == 1 && params.labels.containsKey(params.unannotatedClass)))) 777 | throw new IllegalArgumentException("You cannot use both useInstanceLabels() and addLabel() - please choose one or the other!"); 778 | if (params.objectFilter == null) 779 | throw new IllegalArgumentException("Please specify an object filter with useInstanceLabels(), for example useDetections(), useCells(), useAnnotations(), useFilter()"); 780 | } 781 | 782 | return new LabeledOffsetImageServer( 783 | imageData, downsample, tileWidth, tileHeight, 784 | new LabeledServerParameters(params), 785 | multichannelOutput, 786 | offset); 787 | } 788 | 789 | } 790 | 791 | 792 | /** 793 | * Returns null (does not support ServerBuilders). 794 | */ 795 | @Override 796 | protected ServerBuilder createServerBuilder() { 797 | return null; 798 | } 799 | 800 | @Override 801 | public Collection getURIs() { 802 | return Collections.emptyList(); 803 | } 804 | 805 | /** 806 | * Returns a UUID. 807 | */ 808 | @Override 809 | protected String createID() { 810 | return UUID.randomUUID().toString(); 811 | } 812 | 813 | /** 814 | * Returns true if there are no objects to be painted within the requested region. 815 | *

816 | * @apiNote In v0.2 this performed a fast bounding box check only. In v0.3 it was updated to test ROIs fully for 817 | * an intersection. 818 | * @implNote Since v0.3 the request is expanded by the line thickness before testing intersection. In some edge cases, this might result 819 | * in returning true even if nothing is drawn within the region. There remains a balance between returning quickly and 820 | * giving an exact result. 821 | */ 822 | @Override 823 | public boolean isEmptyRegion(RegionRequest request) { 824 | double thicknessScale = request.getDownsample() / getDownsampleForResolution(0); 825 | int pad = (int)Math.ceil(params.lineThickness * thicknessScale); 826 | var request2 = pad > 0 ? request.pad2D(pad, pad) : request; 827 | return !getObjectsForRegion(request2) 828 | .stream() 829 | .anyMatch(p -> RoiTools.intersectsRegion(p.getROI(), request2)); 830 | } 831 | 832 | /** 833 | * Get the objects to be painted that fall within a specified region. 834 | * Note that this does not take into consideration line thickness, and therefore results are not guaranteed 835 | * to match {@link #isEmptyRegion(RegionRequest)}; in other worse, an object might fall outside the region 836 | * but still influence an image type because of thick lines being drawn. 837 | * If thicker lines should influence the result, the region should be padded accordingly. 838 | * 839 | * @param region 840 | * 841 | * @return a list of objects with ROIs that intersect the specified region 842 | */ 843 | public List getObjectsForRegion(ImageRegion region) { 844 | return hierarchy.getObjectsForRegion(null, region, null).stream() 845 | .filter(params.objectFilter) 846 | .filter(p -> params.createInstanceLabels || params.labels.containsKey(p.getPathClass()) || params.boundaryLabels.containsKey(p.getPathClass())) 847 | .collect(Collectors.toList()); 848 | } 849 | 850 | @Override 851 | public void close() {} 852 | 853 | @Override 854 | public String getServerType() { 855 | return "Labelled image"; 856 | } 857 | 858 | @Override 859 | public ImageServerMetadata getOriginalMetadata() { 860 | return originalMetadata; 861 | } 862 | 863 | /** 864 | * Throws an exception - metadata should not be set for a hierarchy image server directly. Any changes should be made to the underlying 865 | * image server for which this server represents an object hierarchy. 866 | */ 867 | @Override 868 | public void setMetadata(ImageServerMetadata metadata) { 869 | throw new IllegalArgumentException("Metadata cannot be set for a labelled image server!"); 870 | } 871 | 872 | @Override 873 | protected BufferedImage createDefaultRGBImage(int width, int height) { 874 | // GraphicsConfiguration gc = GraphicsEnvironment.getLocalGraphicsEnvironment().getDefaultScreenDevice().getDefaultConfiguration(); 875 | // return gc.createCompatibleImage(width, height, Transparency.TRANSLUCENT); 876 | return new BufferedImage(width, height, BufferedImage.TYPE_INT_ARGB); 877 | } 878 | 879 | @Override 880 | protected BufferedImage readTile(TileRequest tileRequest) throws IOException { 881 | long startTime = System.currentTimeMillis(); 882 | 883 | var pathObjects = hierarchy.getObjectsForRegion(null, tileRequest.getRegionRequest(), null) 884 | .stream() 885 | .filter(params.objectFilter) 886 | .collect(Collectors.toList()); 887 | BufferedImage img; 888 | if (multichannelOutput) { 889 | img = createMultichannelTile(tileRequest, pathObjects); 890 | 891 | } else { 892 | img = createIndexedColorTile(tileRequest, pathObjects); 893 | } 894 | 895 | long endTime = System.currentTimeMillis(); 896 | logger.trace("Labelled tile rendered in {} ms", endTime - startTime); 897 | return img; 898 | } 899 | 900 | 901 | private BufferedImage createMultichannelTile(TileRequest tileRequest, Collection pathObjects) { 902 | 903 | int nChannels = nChannels(); 904 | if (nChannels == 1) 905 | return createBinaryTile(tileRequest, pathObjects, 0); 906 | 907 | int tileWidth = tileRequest.getTileWidth(); 908 | int tileHeight = tileRequest.getTileHeight(); 909 | byte[][] dataArray = new byte[nChannels][]; 910 | for (int i = 0; i < nChannels; i++) { 911 | var tile = createBinaryTile(tileRequest, pathObjects, i); 912 | dataArray[i] = ((DataBufferByte)tile.getRaster().getDataBuffer()).getData(); 913 | } 914 | DataBuffer buffer = new DataBufferByte(dataArray, tileWidth * tileHeight); 915 | 916 | int[] offsets = new int[nChannels]; 917 | for (int b = 0; b < nChannels; b++) 918 | offsets[b] = b * tileWidth * tileHeight; 919 | 920 | var sampleModel = new BandedSampleModel(buffer.getDataType(), tileWidth, tileHeight, nChannels); 921 | // var sampleModel = new ComponentSampleModel(buffer.getDataType(), tileWidth, tileHeight, 1, tileWidth, offsets); 922 | 923 | var raster = WritableRaster.createWritableRaster(sampleModel, buffer, null); 924 | 925 | return new BufferedImage(colorModel, raster, false, null); 926 | } 927 | 928 | private BufferedImage createBinaryTile(TileRequest tileRequest, Collection pathObjects, int label) { 929 | int width = tileRequest.getTileWidth(); 930 | int height = tileRequest.getTileHeight(); 931 | BufferedImage img = new BufferedImage(width, height, BufferedImage.TYPE_BYTE_GRAY); 932 | WritableRaster raster = img.getRaster(); 933 | Graphics2D g2d = img.createGraphics(); 934 | 935 | if (!pathObjects.isEmpty()) { 936 | 937 | RegionRequest request = tileRequest.getRegionRequest(); 938 | double downsampleFactor = request.getDownsample(); 939 | 940 | g2d.setClip(0, 0, width, height); 941 | double scale = 1.0/downsampleFactor; 942 | g2d.scale(scale, scale); 943 | g2d.translate(-request.getX(), -request.getY()); 944 | g2d.setColor(Color.WHITE); 945 | 946 | BasicStroke stroke = new BasicStroke((float)(params.lineThickness * tileRequest.getDownsample())); 947 | g2d.setStroke(stroke); 948 | 949 | // We want to order consistently to avoid confusing overlaps 950 | for (var entry : params.labels.entrySet()) { 951 | if (entry.getValue() != label) 952 | continue; 953 | var pathClass = getPathClass(entry.getKey()); 954 | for (var pathObject : pathObjects) { 955 | if (getPathClass(pathObject) == pathClass) { 956 | var roi = params.roiFunction.apply(pathObject); 957 | if (roi.isArea()) 958 | g2d.fill(roi.getShape()); 959 | else if (roi.isLine()) 960 | g2d.draw(roi.getShape()); 961 | else if (roi.isPoint()) { 962 | for (var p : roi.getAllPoints()) { 963 | int x = (int)((p.getX() - request.getX()) / downsampleFactor); 964 | int y = (int)((p.getY() - request.getY()) / downsampleFactor); 965 | if (x >= 0 && x < width && y >= 0 && y < height) { 966 | raster.setSample(x, y, 0, 255); 967 | } 968 | } 969 | } 970 | } 971 | } 972 | } 973 | for (var entry : params.boundaryLabels.entrySet()) { 974 | if (entry.getValue() != label) 975 | continue; 976 | for (var pathObject : pathObjects) { 977 | var pathClass = getPathClass(pathObject); 978 | if (params.labels.containsKey(pathClass)) { // && !PathClassTools.isIgnoredClass(pathObject.getPathClass())) { 979 | var roi = params.roiFunction.apply(pathObject); 980 | if (roi.isArea()) { 981 | var shape = roi.getShape(); 982 | g2d.draw(shape); 983 | } 984 | } 985 | } 986 | } 987 | } 988 | 989 | g2d.dispose(); 990 | return img; 991 | } 992 | 993 | 994 | private static Color getColorForLabel(int label, boolean doRGB) { 995 | if (doRGB) 996 | return new Color(label, false); 997 | return ColorToolsAwt.getCachedColor(label, label, label); 998 | } 999 | 1000 | 1001 | private BufferedImage createIndexedColorTile(TileRequest tileRequest, Collection pathObjects) { 1002 | 1003 | RegionRequest request = tileRequest.getRegionRequest(); 1004 | 1005 | double downsampleFactor = request.getDownsample(); 1006 | 1007 | // Fill in the background color 1008 | int width = tileRequest.getTileWidth(); 1009 | int height = tileRequest.getTileHeight(); 1010 | boolean doRGB = maxLabel > 255; 1011 | // If we have > 255 labels, we can only use Graphics2D if we pretend to have an RGB image 1012 | BufferedImage img = doRGB ? new BufferedImage(width, height, BufferedImage.TYPE_INT_RGB) : new BufferedImage(width, height, BufferedImage.TYPE_BYTE_GRAY); 1013 | WritableRaster raster = img.getRaster(); 1014 | 1015 | Graphics2D g2d = img.createGraphics(); 1016 | int bgLabel = params.labels.get(params.unannotatedClass); 1017 | Color color = getColorForLabel(bgLabel, doRGB); 1018 | g2d.setColor(color); 1019 | g2d.fillRect(0, 0, width, height); 1020 | 1021 | if (!pathObjects.isEmpty()) { 1022 | g2d.setClip(0, 0, width, height); 1023 | double scale = 1.0/downsampleFactor; 1024 | g2d.scale(scale, scale); 1025 | g2d.translate(-request.getX(), -request.getY()); 1026 | 1027 | BasicStroke stroke = new BasicStroke((float)(params.lineThickness * tileRequest.getDownsample())); 1028 | g2d.setStroke(stroke); 1029 | 1030 | // We want to order consistently to avoid confusing overlaps 1031 | for (var entry : params.labels.entrySet()) { 1032 | var pathClass = getPathClass(entry.getKey()); 1033 | int c = entry.getValue(); 1034 | color = getColorForLabel(c, doRGB); 1035 | List toDraw; 1036 | if (instanceClassMapInverse != null) { 1037 | var temp = instanceClassMapInverse.get(c); 1038 | if (temp == null) 1039 | continue; 1040 | toDraw = Collections.singletonList(temp); 1041 | } else 1042 | toDraw = pathObjects 1043 | .stream() 1044 | .filter(p -> getPathClass(p) == pathClass) 1045 | .collect(Collectors.toList()); 1046 | 1047 | for (var pathObject : toDraw) { 1048 | var roi = params.roiFunction.apply(pathObject); 1049 | g2d.setColor(color); 1050 | if (roi.isArea()) 1051 | g2d.fill(roi.getShape()); 1052 | else if (roi.isLine()) 1053 | g2d.draw(roi.getShape()); 1054 | else if (roi.isPoint()) { 1055 | for (var p : roi.getAllPoints()) { 1056 | int x = (int)((p.getX() - request.getX()) / downsampleFactor); 1057 | int y = (int)((p.getY() - request.getY()) / downsampleFactor); 1058 | if (x >= 0 && x < width && y >= 0 && y < height) { 1059 | if (doRGB) 1060 | img.setRGB(x, y, color.getRGB()); 1061 | else 1062 | raster.setSample(x, y, 0, c); 1063 | } 1064 | } 1065 | } 1066 | } 1067 | } 1068 | for (var entry : params.boundaryLabels.entrySet()) { 1069 | int c = entry.getValue(); 1070 | color = getColorForLabel(c, doRGB); 1071 | for (var pathObject : pathObjects) { 1072 | // if (pathObject.getPathClass() == pathClass) { 1073 | var pathClass = getPathClass(pathObject); 1074 | if (params.labels.containsKey(pathClass)) {// && !PathClassTools.isIgnoredClass(pathObject.getPathClass())) { 1075 | var roi = params.roiFunction.apply(pathObject); 1076 | if (roi.isArea()) { 1077 | g2d.setColor(color); 1078 | g2d.draw(roi.getShape()); 1079 | } 1080 | } 1081 | } 1082 | } 1083 | } 1084 | g2d.dispose(); 1085 | if (doRGB) { 1086 | // Resort to RGB if we have to 1087 | WritableRaster shortRaster = null; 1088 | int w = img.getWidth(); 1089 | int h = img.getHeight(); 1090 | switch (getPixelType()) { 1091 | case UINT8: 1092 | return img; 1093 | case FLOAT32: 1094 | shortRaster = WritableRaster.createWritableRaster( 1095 | new BandedSampleModel(DataBuffer.TYPE_FLOAT, w, h, 1), 1096 | null); 1097 | break; 1098 | case FLOAT64: 1099 | shortRaster = WritableRaster.createWritableRaster( 1100 | new BandedSampleModel(DataBuffer.TYPE_DOUBLE, w, h, 1), 1101 | null); 1102 | break; 1103 | case INT16: 1104 | shortRaster = WritableRaster.createWritableRaster( 1105 | new BandedSampleModel(DataBuffer.TYPE_SHORT, w, h, 1), 1106 | null); 1107 | break; 1108 | case INT8: 1109 | case UINT16: 1110 | shortRaster = WritableRaster.createWritableRaster( 1111 | new BandedSampleModel(DataBuffer.TYPE_USHORT, w, h, 1), 1112 | null); 1113 | break; 1114 | case INT32: 1115 | case UINT32: 1116 | shortRaster = WritableRaster.createWritableRaster( 1117 | new BandedSampleModel(DataBuffer.TYPE_INT, w, h, 1), 1118 | null); 1119 | break; 1120 | default: 1121 | break; 1122 | } 1123 | if (maxLabel >= 65536 || shortRaster == null) { 1124 | return img; 1125 | } 1126 | // Transfer RGB values as labels to the new raster 1127 | int[] samples = img.getRGB(0, 0, width, height, null, 0, width); 1128 | shortRaster.setSamples(0, 0, width, height, 0, samples); 1129 | // System.err.println("Before: " + Arrays.stream(samples).summaryStatistics()); 1130 | raster = shortRaster; 1131 | // samples = raster.getSamples(0, 0, width, height, 0, (int[])null); 1132 | // System.err.println("After: " + Arrays.stream(samples).summaryStatistics()); 1133 | } 1134 | return new BufferedImage(colorModel, raster, false, null); 1135 | // return new BufferedImage((IndexColorModel)colorModel, raster, false, null); 1136 | } 1137 | 1138 | 1139 | } -------------------------------------------------------------------------------- /src/main/resources/META-INF/services/qupath.lib.gui.extensions.QuPathExtension: -------------------------------------------------------------------------------- 1 | org.elephant.cellsparse.CellsparseCellposeExtension 2 | org.elephant.cellsparse.CellsparseElephantExtension 3 | org.elephant.cellsparse.CellsparseStarDistExtension --------------------------------------------------------------------------------